close()

Close httplib2 connections.

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

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

Args:
parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
body: object, The request body.
The object takes the form of:

{ # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
"customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
"customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
},
"ports": [ # Ports to expose from the container.
{ # Represents a network port in a container.
"port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
"protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
},
],
"resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
"limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
"a_key": "A String",
},
"requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
"a_key": "A String",
},
},
},
"defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
"defaultContainerCategory": "A String", # Required. The category of the default container image.
"resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container.
"limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
"a_key": "A String",
},
"requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
"a_key": "A String",
},
},
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
"egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
"customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.
{ # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by `domain` is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the `domain`. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"internetAccess": True or False, # Optional. Whether to allow internet access.
"networkAttachment": "A String", # Optional. The name of the customer VPC `NetworkAttachment` used to draw a PSC interface IP into the customer VPC for sandbox egress.
},
"ingressControlConfig": { # Represents configuration for private service connect. # Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on `SandboxEnvironment.connection_info.service_attachment`. Only the PSC-E (service-attachment/ingress) portion of `PrivateServiceConnectConfig` applies here: `enable_private_service_connect` and `project_allowlist` (the consumer projects allowed to connect). The nested `psc_interface_config` (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via `egress_control_config` instead.
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
"enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled.
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
"A String",
],
"pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only.
{ # PSC config that is used to automatically create PSC endpoints in the user projects.
"errorMessage": "A String", # Output only. Error message if the PSC service automation failed.
"forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation.
"ipAddress": "A String", # Output only. IP address rule created by the PSC service automation.
"network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`.
"projectId": "A String", # Required. Project id used to create forwarding rule.
"state": "A String", # Output only. The state of the PSC service automation.
},
],
"serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.
},
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
}

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, x__xgafv=None)

Deletes the specific SandboxEnvironmentTemplate.

Args:
name: string, Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
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 the specific SandboxEnvironmentTemplate.

Args:
  name: string, Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
    },
    "ports": [ # Ports to expose from the container.
      { # Represents a network port in a container.
        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
      },
    ],
    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
        "a_key": "A String",
      },
      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
        "a_key": "A String",
      },
    },
  },
  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
    "defaultContainerCategory": "A String", # Required. The category of the default container image.
    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container.
      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
        "a_key": "A String",
      },
      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
        "a_key": "A String",
      },
    },
  },
  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
  "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
    "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into.
    "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.
      { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.
        "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
        "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by `domain` is visible.
        "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the `domain`. The Vertex AI Service Agent requires the dns.peer role on this project.
      },
    ],
    "internetAccess": True or False, # Optional. Whether to allow internet access.
    "networkAttachment": "A String", # Optional. The name of the customer VPC `NetworkAttachment` used to draw a PSC interface IP into the customer VPC for sandbox egress.
  },
  "ingressControlConfig": { # Represents configuration for private service connect. # Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on `SandboxEnvironment.connection_info.service_attachment`. Only the PSC-E (service-attachment/ingress) portion of `PrivateServiceConnectConfig` applies here: `enable_private_service_connect` and `project_allowlist` (the consumer projects allowed to connect). The nested `psc_interface_config` (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via `egress_control_config` instead.
    "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
    "enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled.
    "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
      "A String",
    ],
    "pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only.
      { # PSC config that is used to automatically create PSC endpoints in the user projects.
        "errorMessage": "A String", # Output only. Error message if the PSC service automation failed.
        "forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation.
        "ipAddress": "A String", # Output only. IP address rule created by the PSC service automation.
        "network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`.
        "projectId": "A String", # Required. Project id used to create forwarding rule.
        "state": "A String", # Output only. The state of the PSC service automation.
      },
    ],
    "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.
  },
  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
  "state": "A String", # Output only. The state of the sandbox environment template.
  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
}

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

Lists SandboxEnvironmentTemplates in a given reasoning engine.

Args:
  parent: string, Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SandboxEnvironmentService.ListSandboxEnvironmentTemplates.
  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
  "sandboxEnvironmentTemplates": [ # The SandboxEnvironmentTemplates matching the request.
    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
      "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
        "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
        },
        "ports": [ # Ports to expose from the container.
          { # Represents a network port in a container.
            "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
            "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
          },
        ],
        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
            "a_key": "A String",
          },
          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
            "a_key": "A String",
          },
        },
      },
      "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
        "defaultContainerCategory": "A String", # Required. The category of the default container image.
        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container.
          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
            "a_key": "A String",
          },
          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
            "a_key": "A String",
          },
        },
      },
      "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
      "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
        "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into.
        "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.
          { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.
            "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
            "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by `domain` is visible.
            "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the `domain`. The Vertex AI Service Agent requires the dns.peer role on this project.
          },
        ],
        "internetAccess": True or False, # Optional. Whether to allow internet access.
        "networkAttachment": "A String", # Optional. The name of the customer VPC `NetworkAttachment` used to draw a PSC interface IP into the customer VPC for sandbox egress.
      },
      "ingressControlConfig": { # Represents configuration for private service connect. # Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on `SandboxEnvironment.connection_info.service_attachment`. Only the PSC-E (service-attachment/ingress) portion of `PrivateServiceConnectConfig` applies here: `enable_private_service_connect` and `project_allowlist` (the consumer projects allowed to connect). The nested `psc_interface_config` (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via `egress_control_config` instead.
        "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
        "enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled.
        "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
          "A String",
        ],
        "pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only.
          { # PSC config that is used to automatically create PSC endpoints in the user projects.
            "errorMessage": "A String", # Output only. Error message if the PSC service automation failed.
            "forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation.
            "ipAddress": "A String", # Output only. IP address rule created by the PSC service automation.
            "network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`.
            "projectId": "A String", # Required. Project id used to create forwarding rule.
            "state": "A String", # Output only. The state of the PSC service automation.
          },
        ],
        "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.
      },
      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
      "state": "A String", # Output only. The state of the sandbox environment template.
      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
    },
  ],
}

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.

Agent Platform API . reasoningEngines . sandboxEnvironmentTemplates

Instance Methods

Method Details