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

Creates a new AgentConnectivityTemplate in a given project and location.

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

{ # AgentConnectivityTemplate represents a reusable network configuration.
  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
    "A String",
  ],
  "agentCompute": "A String", # Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen.
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "deploymentModel": "A String", # Required. The deployment model for the gateway.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
      "domain": "A String", # Optional. The domain to peer.
      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
    },
    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
    "trustConfig": "A String", # Optional. Deprecated: Use tls_config instead. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
    "vpcEgress": "A String", # Optional. The VPC egress setting.
  },
  "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.
  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}

  agentConnectivityTemplateId: string, Required. Short name of the AgentConnectivityTemplate 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 AgentConnectivityTemplate.

Args:
name: string, Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`. (required)
etag: string, Optional. The etag of the AgentConnectivityTemplate 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 AgentConnectivityTemplate.

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

Returns:
  An object of the form:

    { # AgentConnectivityTemplate represents a reusable network configuration.
  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
    "A String",
  ],
  "agentCompute": "A String", # Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen.
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "deploymentModel": "A String", # Required. The deployment model for the gateway.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
      "domain": "A String", # Optional. The domain to peer.
      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
    },
    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
    "trustConfig": "A String", # Optional. Deprecated: Use tls_config instead. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
    "vpcEgress": "A String", # Optional. The VPC egress setting.
  },
  "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.
  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}

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

Lists AgentConnectivityTemplates in a given project and location.

Args:
  parent: string, Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`. (required)
  pageSize: integer, Optional. Maximum number of AgentConnectivityTemplates to return per call.
  pageToken: string, Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` 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 ListAgentConnectivityTemplates method.
  "agentConnectivityTemplates": [ # List of AgentConnectivityTemplate resources.
    { # AgentConnectivityTemplate represents a reusable network configuration.
      "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
      "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
        "A String",
      ],
      "agentCompute": "A String", # Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen.
      "createTime": "A String", # Output only. The timestamp when the resource was created.
      "deploymentModel": "A String", # Required. The deployment model for the gateway.
      "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
      "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
        "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
          "domain": "A String", # Optional. The domain to peer.
          "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
        },
        "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
        "trustConfig": "A String", # Optional. Deprecated: Use tls_config instead. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
        "vpcEgress": "A String", # Optional. The VPC egress setting.
      },
      "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.
      "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
      "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": [ # Unordered list. 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 AgentConnectivityTemplate.

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

{ # AgentConnectivityTemplate represents a reusable network configuration.
  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
    "A String",
  ],
  "agentCompute": "A String", # Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen.
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "deploymentModel": "A String", # Required. The deployment model for the gateway.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
      "domain": "A String", # Optional. The domain to peer.
      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
    },
    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
    "trustConfig": "A String", # Optional. Deprecated: Use tls_config instead. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
    "vpcEgress": "A String", # Optional. The VPC egress setting.
  },
  "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.
  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
  "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 AgentConnectivityTemplate 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.
  },
}

Network Services API . projects . locations . agentConnectivityTemplates

Instance Methods

Method Details