+ close()
Close httplib2 connections.
+
+ create(parent, bindingId=None, body=None, requestId=None, x__xgafv=None)
Creates a new Binding in a given project and location.
+
+ delete(name, requestId=None, x__xgafv=None)
Deletes a single Binding.
+ +Fetches available Bindings.
+ +Retrieves the next page of results.
+ +Gets details of a single Binding.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Bindings in a given project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single Binding.
+close()
+ Close httplib2 connections.+
create(parent, bindingId=None, body=None, requestId=None, x__xgafv=None)
+ Creates a new Binding in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to create the Binding in. Expected format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+ bindingId: string, Required. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ 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, requestId=None, x__xgafv=None)
+ Deletes a single Binding.
+
+Args:
+ name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ 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.
+ },
+}
+fetchAvailable(parent, pageSize=None, pageToken=None, sourceIdentifier=None, targetIdentifier=None, x__xgafv=None)
+ Fetches available Bindings.
+
+Args:
+ parent: string, Required. The parent, in the format `projects/{project}/locations/{location}`. (required)
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ sourceIdentifier: string, The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ targetIdentifier: string, Optional. The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to fetching available Bindings.
+ "bindings": [ # The list of Bindings.
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+fetchAvailable_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. ++
get(name, x__xgafv=None)
+ Gets details of a single Binding.
+
+Args:
+ name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Bindings in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to list bindings in. Expected format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. A query string used to filter the list of bindings returned. The filter expression must follow AIP-160 syntax.
+ orderBy: string, Optional. Hint for how to order the results
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Bindings
+ "bindings": [ # The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
+}
+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, requestId=None, updateMask=None, x__xgafv=None)
+ Updates the parameters of a single Binding.
+
+Args:
+ name: string, Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Binding 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 present in the request 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.
+ },
+}
+Returns the agents Resource.
+
+ bindings()
+
Returns the bindings Resource.
+ diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html index 03af1328aa..c559484dce 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html @@ -133,7 +133,7 @@Returns the operations Resource.
+ +Returns the runtimeRevisions Resource.
+ +
+ sandboxEnvironmentSnapshots()
+
Returns the sandboxEnvironmentSnapshots Resource.
+ +
+ sandboxEnvironmentTemplates()
+
Returns the sandboxEnvironmentTemplates Resource.
+ @@ -152,17 +167,18 @@Update a Memory.
Args:
- name: string, Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+ name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
body: object, The request body.
The object takes the form of:
{ # A memory.
- "createTime": "A String", # Output only. Timestamp when this Memory was created.
- "description": "A String", # Optional. Description of the Memory.
- "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request.
- "displayName": "A String", # Optional. Display name of the Memory.
- "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
- "fact": "A String", # Optional. Semantic knowledge extracted from the source content.
- "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+ "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+ "description": "A String", # Optional. Represents the description of the Memory.
+ "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+ "displayName": "A String", # Optional. Represents the display name of the Memory.
+ "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+ "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+ "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
"a_key": { # Memory metadata.
- "boolValue": True or False, # Boolean value.
- "doubleValue": 3.14, # Double value.
- "stringValue": "A String", # String value.
- "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+ "boolValue": True or False, # Represents a boolean value.
+ "doubleValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
},
},
- "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
- "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
- "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.
+ "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+ "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+ "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
"a_key": "A String",
},
- "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.
- "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+ "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+ "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
- "topics": [ # Optional. The Topics of the Memory.
+ "topics": [ # Optional. Represents the Topics of the Memory.
{ # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
- "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label.
- "managedMemoryTopic": "A String", # Optional. The managed memory topic.
+ "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+ "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
},
],
- "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
- "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
+ "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+ "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
}
updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`
@@ -596,16 +602,16 @@ Method Details
"filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160).
"filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
{ # A conjunction of filters that will be combined using AND logic.
- "filters": [ # Filters that will combined using AND logic.
+ "filters": [ # Represents filters that will be combined using AND logic.
{ # Filter to apply when retrieving memories.
- "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
- "negate": True or False, # If true, the filter will be negated.
- "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used.
- "value": { # Memory metadata. # Value to compare to.
- "boolValue": True or False, # Boolean value.
- "doubleValue": 3.14, # Double value.
- "stringValue": "A String", # String value.
- "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+ "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+ "negate": True or False, # Indicates whether the filter will be negated.
+ "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+ "value": { # Memory metadata. # Represents the value to compare to.
+ "boolValue": True or False, # Represents a boolean value.
+ "doubleValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
},
},
],
@@ -656,21 +662,24 @@ Method Details
"filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
"filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
{ # A conjunction of filters that will be combined using AND logic.
- "filters": [ # Filters that will combined using AND logic.
+ "filters": [ # Represents filters that will be combined using AND logic.
{ # Filter to apply when retrieving memories.
- "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
- "negate": True or False, # If true, the filter will be negated.
- "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used.
- "value": { # Memory metadata. # Value to compare to.
- "boolValue": True or False, # Boolean value.
- "doubleValue": 3.14, # Double value.
- "stringValue": "A String", # String value.
- "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+ "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+ "negate": True or False, # Indicates whether the filter will be negated.
+ "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+ "value": { # Memory metadata. # Represents the value to compare to.
+ "boolValue": True or False, # Represents a boolean value.
+ "doubleValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
},
},
],
},
],
+ "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.
+ "A String",
+ ],
"scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive.
"a_key": "A String",
},
@@ -698,37 +707,37 @@ Method Details
{ # A retrieved memory.
"distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval.
"memory": { # A memory. # The retrieved Memory.
- "createTime": "A String", # Output only. Timestamp when this Memory was created.
- "description": "A String", # Optional. Description of the Memory.
- "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request.
- "displayName": "A String", # Optional. Display name of the Memory.
- "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
- "fact": "A String", # Optional. Semantic knowledge extracted from the source content.
- "metadata": { # Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+ "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+ "description": "A String", # Optional. Represents the description of the Memory.
+ "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+ "displayName": "A String", # Optional. Represents the display name of the Memory.
+ "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+ "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+ "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
"a_key": { # Memory metadata.
- "boolValue": True or False, # Boolean value.
- "doubleValue": 3.14, # Double value.
- "stringValue": "A String", # String value.
- "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+ "boolValue": True or False, # Represents a boolean value.
+ "doubleValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
},
},
- "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
- "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
- "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.
+ "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+ "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+ "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
"a_key": "A String",
},
- "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.
- "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+ "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+ "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
- "topics": [ # Optional. The Topics of the Memory.
+ "topics": [ # Optional. Represents the Topics of the Memory.
{ # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
- "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label.
- "managedMemoryTopic": "A String", # Optional. The managed memory topic.
+ "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+ "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
},
],
- "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
- "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
+ "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+ "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
},
},
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html
index 2be3271b60..7e05278789 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html
@@ -107,18 +107,25 @@ Method Details
An object of the form:
{ # A revision of a Memory.
- "createTime": "A String", # Output only. Timestamp when this Memory Revision was created.
- "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired.
- "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+ "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+ "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+ "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
{ # An extracted memory that is the intermediate result before consolidation.
- "fact": "A String", # Output only. The fact of the extracted memory.
+ "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+ "fact": "A String", # Output only. Represents the fact of the extracted memory.
+ "structuredData": { # Output only. Represents the structured value of the extracted memory.
+ "a_key": "", # Properties of the object.
+ },
},
],
- "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
- "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+ "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+ "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
"a_key": "A String",
},
- "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+ "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+ "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+ "a_key": "", # Properties of the object.
+ },
}
@@ -142,18 +149,25 @@
+ close()
Close httplib2 connections.
+
+ query(name, body=None, x__xgafv=None)
Queries using a reasoning engine.
+
+ streamQuery(name, body=None, x__xgafv=None)
Streams queries using a reasoning engine.
+close()
+ Close httplib2 connections.+
query(name, body=None, x__xgafv=None)
+ Queries using a reasoning engine.
+
+Args:
+ name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.Query.
+ "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
+ "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+ "a_key": "", # Properties of the object.
+ },
+}
+
+ 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 ReasoningEngineExecutionService.Query
+ "output": "", # Response provided by users in JSON object format.
+}
+streamQuery(name, body=None, x__xgafv=None)
+ Streams queries using a reasoning engine.
+
+Args:
+ name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+ "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+ "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+ "a_key": "", # Properties of the object.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+ +Deletes the specific SandboxEnvironmentSnapshot.
+ +Gets details of the specific SandboxEnvironmentSnapshot.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists SandboxEnvironmentSnapshots in a given reasoning engine.
+ +Retrieves the next page of results.
+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. ++
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (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.
+ },
+}
+wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ 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.
+ },
+}
+
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a SandboxEnvironmentTemplate in a given reasoning engine.
+ +Deletes the specific SandboxEnvironmentTemplate.
+ +Gets details of the specific SandboxEnvironmentTemplate.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists SandboxEnvironmentTemplates in a given reasoning engine.
+ +Retrieves the next page of results.
+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.
+ },
+ "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "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.
+ "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+ "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+ },
+}
+
+ 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.
+ },
+ "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "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.
+ "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+ "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+ },
+}
+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.
+ },
+ "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "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.
+ "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+ "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+ },
+ },
+ ],
+}
+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. ++
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (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.
+ },
+}
+wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ 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.
+ },
+}
+Retrieves the next page of results.
+
+ snapshot(name, body=None, x__xgafv=None)
Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
close()
@@ -119,6 +122,7 @@ snapshot(name, body=None, x__xgafv=None)
+ Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
+
+Args:
+ name: string, Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # 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.
+}
+
+ 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.
+ },
+}
+