Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentSnapshots

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes the specific SandboxEnvironmentSnapshot.

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

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

Returns:
  An object of the form:

    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
  "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 SandboxEnvironmentSnapshots 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 SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` 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.ListSandboxEnvironmentSnapshots.
  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
  "sandboxEnvironmentSnapshots": [ # The SandboxEnvironmentSnapshots matching the request.
    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
      "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
      "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
      "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
      "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
      "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
      "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
      "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.