close()

Close httplib2 connections.

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

Creates a SandboxEnvironment in a given reasoning engine.

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

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"metadata": "", # Output only. Additional information about the SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
"dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3".
"A String",
],
"env": [ # Optional. The environment variables to set in the code execution environment.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"machineConfig": "A String", # The machine config of the code execution environment.
},
},
"state": "A String", # Output only. The runtime state of the SandboxEnvironment.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment 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 SandboxEnvironment.

Args:
name: string, Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (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.
},
}

execute(name, body=None, x__xgafv=None)

Executes using a sandbox environment.

Args:
  name: string, Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SandboxEnvironmentExecutionService.Execute.
  "inputs": [ # Required. The inputs to the sandbox environment.
    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
      "data": "A String", # Required. The data in the chunk.
      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
          "a_key": "A String",
        },
      },
      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
    },
  ],
}

  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 SandboxEnvironmentExecutionService.Execute.
  "outputs": [ # The outputs from the sandbox environment.
    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
      "data": "A String", # Required. The data in the chunk.
      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
          "a_key": "A String",
        },
      },
      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
    },
  ],
}

get(name, x__xgafv=None)

Gets details of the specific SandboxEnvironment.

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

Returns:
  An object of the form:

    { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
  "displayName": "A String", # Required. The display name of the SandboxEnvironment.
  "metadata": "", # Output only. Additional information about the SandboxEnvironment.
  "name": "A String", # Identifier. The name of the SandboxEnvironment.
  "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
    "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
      "codeLanguage": "A String", # The coding language supported in this environment.
      "dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3".
        "A String",
      ],
      "env": [ # Optional. The environment variables to set in the code execution environment.
        { # Represents an environment variable present in a Container or Python Module.
          "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
          "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
        },
      ],
      "machineConfig": "A String", # The machine config of the code execution environment.
    },
  },
  "state": "A String", # Output only. The runtime state of the SandboxEnvironment.
  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
}

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

Lists SandboxEnvironments in a given reasoning engine.

Args:
  parent: string, Required. The resource name of the reasoning engine to list sandbox environments 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 SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.
  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironments` 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.ListSandboxEnvironments.
  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
  "sandboxEnvironments": [ # The SandboxEnvironments matching the request.
    { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
      "displayName": "A String", # Required. The display name of the SandboxEnvironment.
      "metadata": "", # Output only. Additional information about the SandboxEnvironment.
      "name": "A String", # Identifier. The name of the SandboxEnvironment.
      "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
        "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
          "codeLanguage": "A String", # The coding language supported in this environment.
          "dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3".
            "A String",
          ],
          "env": [ # Optional. The environment variables to set in the code execution environment.
            { # Represents an environment variable present in a Container or Python Module.
              "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
              "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
            },
          ],
          "machineConfig": "A String", # The machine config of the code execution environment.
        },
      },
      "state": "A String", # Output only. The runtime state of the SandboxEnvironment.
      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment 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.

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironments

Instance Methods

Method Details