Network Services API . projects . locations . agentGateways

Instance Methods

close()

Close httplib2 connections.

create(parent, agentGatewayId=None, body=None, x__xgafv=None)

Creates a new AgentGateway in a given project and location.

delete(name, etag=None, x__xgafv=None)

Deletes a single AgentGateway.

get(name, x__xgafv=None)

Gets details of a single AgentGateway.

list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists AgentGateways in a given project and location.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single AgentGateway.

Method Details

close()
Close httplib2 connections.
create(parent, agentGatewayId=None, body=None, x__xgafv=None)
Creates a new AgentGateway in a given project and location.

Args:
  parent: string, Required. The parent resource of the AgentGateway. Must be in the format `projects/*/locations/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # AgentGateway represents the agent gateway resource.
  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
      "A String",
    ],
    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
  },
  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
        "A String",
      ],
      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
    },
    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
    },
  },
  "protocols": [ # Required. List of protocols supported by an Agent Gateway
    "A String",
  ],
  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
    "A String",
  ],
  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
  },
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}

  agentGatewayId: string, Required. Short name of the AgentGateway resource to be created.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, etag=None, x__xgafv=None)
Deletes a single AgentGateway.

Args:
  name: string, Required. A name of the AgentGateway to delete. Must be in the format `projects/*/locations/*/agentGateways/*`. (required)
  etag: string, Optional. The etag of the AgentGateway to delete.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)
Gets details of a single AgentGateway.

Args:
  name: string, Required. A name of the AgentGateway to get. Must be in the format `projects/*/locations/*/agentGateways/*`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AgentGateway represents the agent gateway resource.
  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
      "A String",
    ],
    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
  },
  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
        "A String",
      ],
      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
    },
    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
    },
  },
  "protocols": [ # Required. List of protocols supported by an Agent Gateway
    "A String",
  ],
  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
    "A String",
  ],
  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
  },
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists AgentGateways in a given project and location.

Args:
  parent: string, Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`. (required)
  pageSize: integer, Optional. Maximum number of AgentGateways to return per call.
  pageToken: string, Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` call, and that the system should return the next page of data.
  returnPartialSuccess: boolean, Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response returned by the ListAgentGateways method.
  "agentGateways": [ # List of AgentGateway resources.
    { # AgentGateway represents the agent gateway resource.
      "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
        "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
        "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
          "A String",
        ],
        "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
      },
      "createTime": "A String", # Output only. The timestamp when the resource was created.
      "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
      "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
      "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
        "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
      },
      "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
      "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
        "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
          "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
            "A String",
          ],
          "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
          "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
        },
        "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
          "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
        },
      },
      "protocols": [ # Required. List of protocols supported by an Agent Gateway
        "A String",
      ],
      "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
        "A String",
      ],
      "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
        "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
      },
      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
    },
  ],
  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
  "unreachable": [ # Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single AgentGateway.

Args:
  name: string, Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # AgentGateway represents the agent gateway resource.
  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
      "A String",
    ],
    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
  },
  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
        "A String",
      ],
      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
    },
    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
    },
  },
  "protocols": [ # Required. List of protocols supported by an Agent Gateway
    "A String",
  ],
  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
    "A String",
  ],
  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
  },
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}

  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AgentGateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}