generateSyntheticData(location, body=None, x__xgafv=None)
Generates synthetic (artificial) data based on a description
-
- generateUserScenarios(location, body=None, x__xgafv=None)
Generates user scenarios for agent evaluation.
Gets information about a location.
@@ -300,7 +297,7 @@Gets a RagEngineConfig.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -359,7 +356,7 @@generateUserScenarios(location, body=None, x__xgafv=None)
- Generates user scenarios for agent evaluation.
-
-Args:
- location: string, Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}` (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for DataFoundryService.GenerateUserScenarios.
- "agents": { # Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.
- "a_key": { # Represents configuration for an Agent.
- "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.
- "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.
- "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.
- "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.
- "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.
- "A String",
- ],
- "tools": [ # Optional. The list of tools available to this agent.
- { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
- "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
- },
- "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
- "environment": "A String", # Required. The environment being operated.
- "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
- "A String",
- ],
- },
- "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
- "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
- "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
- "A String",
- ],
- },
- "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
- { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
- "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
- "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64.
- "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
- "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
- "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
- # Object with schema name: GoogleCloudAiplatformV1Schema
- ],
- "default": "", # Optional. Default value to use if the field is not specified.
- "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
- "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
- },
- "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
- "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
- "A String",
- ],
- "example": "", # Optional. Example of an instance of this schema.
- "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
- "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
- "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
- "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
- "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
- "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
- "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
- "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
- "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
- "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
- "nullable": True or False, # Optional. Indicates if the value of this field can be null.
- "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
- "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
- "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
- },
- "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
- "A String",
- ],
- "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
- "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
- "A String",
- ],
- "title": "A String", # Optional. Title for the schema.
- "type": "A String", # Optional. Data type of the schema field.
- },
- "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
- "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
- "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
- "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
- # Object with schema name: GoogleCloudAiplatformV1Schema
- ],
- "default": "", # Optional. Default value to use if the field is not specified.
- "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
- "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
- },
- "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
- "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
- "A String",
- ],
- "example": "", # Optional. Example of an instance of this schema.
- "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
- "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
- "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
- "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
- "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
- "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
- "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
- "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
- "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
- "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
- "nullable": True or False, # Optional. Indicates if the value of this field can be null.
- "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
- "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
- "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
- },
- "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
- "A String",
- ],
- "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
- "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
- "A String",
- ],
- "title": "A String", # Optional. Title for the schema.
- "type": "A String", # Optional. Data type of the schema field.
- },
- "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
- },
- ],
- "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
- "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
- },
- "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
- "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
- "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
- "A String",
- ],
- "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
- "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
- },
- "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
- },
- },
- },
- "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
- "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
- "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
- "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
- },
- },
- "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
- "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
- "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
- "a_key": "", # Properties of the object.
- },
- },
- "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
- "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
- "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
- "apiKeyConfig": { # The API secret. # The API secret.
- "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
- "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
- },
- },
- "apiSpec": "A String", # The API spec that the external API implements.
- "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
- "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
- "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
- "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
- "httpElementLocation": "A String", # Optional. The location of the API key.
- "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
- },
- "authType": "A String", # Type of auth scheme.
- "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
- "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
- },
- "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
- "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
- },
- "oauthConfig": { # Config for user oauth. # Config for user oauth.
- "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
- "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
- },
- "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
- "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
- "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
- },
- },
- "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
- "index": "A String", # The ElasticSearch index to use.
- "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
- "searchTemplate": "A String", # The ElasticSearch search template to use.
- },
- "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
- "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
- },
- },
- "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
- "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
- { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
- "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
- "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
- },
- ],
- "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
- "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
- "filter": "A String", # Optional. Filter strings to be passed to the search API.
- "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
- },
- "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
- "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
- { # The definition of the Rag resource.
- "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
- "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
- "A String",
- ],
- },
- ],
- "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
- "filter": { # Config for filters. # Optional. Config for filters.
- "metadataFilter": "A String", # Optional. String for metadata filtering.
- "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
- "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
- },
- "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
- "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
- "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
- },
- "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
- "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
- },
- },
- "topK": 42, # Optional. The number of contexts to retrieve.
- },
- "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
- "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
- },
- },
- "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
- },
- },
- ],
- },
- },
- "rootAgentId": "A String", # Required. The agent id to identify the root agent.
- "userScenarioGenerationConfig": { # User scenario generation configuration. # Required. Configuration for generating user scenarios.
- "environmentData": "A String", # Optional. Environment data in string type.
- "modelName": "A String", # Optional. The model name to use for generation. It can be model name, e.g. "gemini-3-pro-preview". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
- "simulationInstruction": "A String", # Optional. Simulation instruction to guide the user scenario generation.
- "userScenarioCount": "A String", # Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100.
- },
-}
-
- 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 DataFoundryService.GenerateUserScenarios.
- "userScenarios": [ # The generated user scenarios used to simulate multi-turn agent running results and agent evaluation.
- { # Output of user scenario generation.
- "conversationPlan": "A String", # Conversation plan to drive multi-turn agent run and get simulated agent eval dataset.
- "startingPrompt": "A String", # Starting prompt for the conversation between simulated user and agent under the test.
- },
- ],
-}
-get(name, x__xgafv=None)
Gets information about a location. @@ -6278,7 +6011,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 86be02d01c..0e6bce10a4 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -532,7 +532,7 @@@@ -7131,7 +7137,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1265,7 +1265,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2391,7 +2391,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 670f68df00..5124091dae 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -315,6 +315,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -350,6 +357,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -668,6 +685,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -703,6 +727,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -952,6 +986,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -987,6 +1028,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -1206,6 +1257,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -1241,6 +1299,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 4c289f7d3d..569ef2be5e 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -518,7 +518,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1102,7 +1102,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2575,7 +2575,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 06d8994179..5a1e3a9697 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -305,6 +305,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -340,6 +347,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -659,6 +676,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -694,6 +718,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -908,6 +942,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -943,6 +984,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -1162,6 +1213,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -1197,6 +1255,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index c096c92bdc..525dbe0b2e 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -887,7 +887,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1196,7 +1196,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1576,7 +1576,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1798,7 +1798,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3944,7 +3944,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 9f71a1354a..6dc7cfcb3e 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -534,7 +534,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1132,7 +1132,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2049,7 +2049,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 257e447cd8..4d5bd735d8 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -279,6 +279,11 @@Instance Methods
Returns the schedules Resource.
++
+semanticGovernancePolicies()+Returns the semanticGovernancePolicies Resource.
+ diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index ef9e4259be..1f91c22400 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -308,7 +308,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -729,7 +729,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1175,7 +1175,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1607,7 +1607,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2047,7 +2047,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2469,7 +2469,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index befb789231..00920397f1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -486,7 +486,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1068,7 +1068,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 14be01375a..c8eb1253ff 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -611,7 +611,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2299,7 +2299,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4961,7 +4961,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index dc77d7a7a4..ce0d3d5bc3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -157,7 +157,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -386,7 +386,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -800,7 +800,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1029,7 +1029,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1442,7 +1442,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1671,7 +1671,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2131,7 +2131,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2360,7 +2360,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2774,7 +2774,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3003,7 +3003,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3416,7 +3416,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3645,7 +3645,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4105,7 +4105,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4334,7 +4334,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4748,7 +4748,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4977,7 +4977,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -5390,7 +5390,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -5619,7 +5619,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6079,7 +6079,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6308,7 +6308,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6722,7 +6722,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6951,7 +6951,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -7364,7 +7364,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -7593,7 +7593,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -8095,7 +8095,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -8324,7 +8324,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -8738,7 +8738,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -8967,7 +8967,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -9380,7 +9380,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -9609,7 +9609,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -10069,7 +10069,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -10298,7 +10298,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -10712,7 +10712,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -10941,7 +10941,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -11354,7 +11354,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -11583,7 +11583,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -12056,7 +12056,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -12285,7 +12285,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -12699,7 +12699,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -12928,7 +12928,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -13341,7 +13341,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -13570,7 +13570,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -14030,7 +14030,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -14259,7 +14259,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -14673,7 +14673,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -14902,7 +14902,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -15315,7 +15315,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -15544,7 +15544,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 4dbac81e3b..4d3cadf59f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -1423,7 +1423,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1788,7 +1788,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3413,7 +3413,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3778,7 +3778,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -5445,7 +5445,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -5810,7 +5810,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -7448,7 +7448,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -7813,7 +7813,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index ae8fe58cd0..a42ae2236a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -222,7 +222,7 @@Method Details
{ # Operation of an extension. "functionDeclaration": { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -397,7 +397,7 @@Method Details
{ # Operation of an extension. "functionDeclaration": { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -611,7 +611,7 @@Method Details
{ # Operation of an extension. "functionDeclaration": { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -803,7 +803,7 @@Method Details
{ # Operation of an extension. "functionDeclaration": { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -977,7 +977,7 @@Method Details
{ # Operation of an extension. "functionDeclaration": { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index f66d5ed212..d69f9d1e81 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -279,6 +279,11 @@Instance Methods
Returns the schedules Resource.
++
+semanticGovernancePolicies()+Returns the semanticGovernancePolicies Resource.
+ @@ -353,7 +358,7 @@Instance Methods
Gets a RagEngineConfig.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -422,7 +427,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -715,7 +720,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2470,7 +2475,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2788,7 +2793,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3179,7 +3184,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3408,7 +3413,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3729,7 +3734,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3958,7 +3963,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6140,7 +6145,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -6830,7 +6835,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -7058,6 +7063,7 @@Method Details
{ # Output of user scenario generation. "conversationPlan": "A String", # Conversation plan to drive multi-turn agent run and get simulated agent eval dataset. "startingPrompt": "A String", # Starting prompt for the conversation between simulated user and agent under the test. + "testCaseTitle": "A String", # Represents a short 3-5 word title for eval test case. }, ], }Method Details
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index b575783ad8..407b836f29 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -553,7 +553,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1375,7 +1375,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2608,7 +2608,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html index 0bde312c9c..2ba2b2a9b9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html @@ -88,6 +88,9 @@Instance Methods
create(parent, a2aTaskId=None, body=None, x__xgafv=None)Creates an A2aTask.
+ +Deletes an A2aTask.
Gets an A2aTask.
@@ -587,7 +590,7 @@Method Details
"role": "A String", # Required. The role of the sender of the message. e.g. "user", "agent" }, }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 365 days by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] "updateTime": "A String", # Output only. The last update timestamp of the task. } @@ -777,11 +780,29 @@Method Details
"role": "A String", # Required. The role of the sender of the message. e.g. "user", "agent" }, }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 365 days by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] "updateTime": "A String", # Output only. The last update timestamp of the task. }++delete(name, x__xgafv=None)+Deletes an A2aTask. + +Args: + name: string, Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` (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); } +}+@@ -1175,7 +1196,7 @@get(name, x__xgafv=None)Gets an A2aTask. @@ -973,7 +994,7 @@Method Details
"role": "A String", # Required. The role of the sender of the message. e.g. "user", "agent" }, }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 365 days by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] "updateTime": "A String", # Output only. The last update timestamp of the task. }Method Details
"role": "A String", # Required. The role of the sender of the message. e.g. "user", "agent" }, }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 365 days by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] "updateTime": "A String", # Output only. The last update timestamp of the task. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 9f4f57b569..2ff44d4461 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -346,6 +346,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -381,6 +388,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -705,6 +722,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -740,6 +764,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -995,6 +1029,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -1030,6 +1071,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -1255,6 +1306,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -1290,6 +1348,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html new file mode 100644 index 0000000000..3f7895e00e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . projects . locations . semanticGovernancePolicies
+Instance Methods
++
+operations()+Returns the operations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.operations.html new file mode 100644 index 0000000000..7995423fcd --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.operations.html @@ -0,0 +1,272 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . projects . locations . semanticGovernancePolicies . operations
+Instance Methods
+ +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.
++
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
++
+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.
+Method Details
+++ +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. + }, +}+++ +list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +Args: + name: string, The name of the operation's parent resource. (required) + filter: string, The standard list filter. + pageSize: integer, The standard list page size. + pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "nextPageToken": "A String", # The standard List next-page token. + "operations": [ # A list of operations that matches the specified filter in the request. + { # 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. + }, + }, + ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 421210ec3c..402b1a71cc 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -147,11 +147,6 @@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. + }, +}+Method Details
"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. - "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. - "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. - }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -1452,11 +1447,6 @@Method Details
"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. - "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. - "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. - }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -2764,11 +2754,6 @@Method Details
"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. - "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. - "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. - }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -4082,11 +4067,6 @@Method Details
"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. - "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. - "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. - }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -5592,11 +5572,6 @@Method Details
"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. - "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. - "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. - }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index a6208e7ee7..86f745c48f 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -533,7 +533,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1131,7 +1131,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -3291,7 +3291,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 9db23c9b3a..5bb583fed2 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -331,6 +331,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -366,6 +373,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -691,6 +708,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -726,6 +750,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -946,6 +980,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -981,6 +1022,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. @@ -1206,6 +1257,13 @@Method Details
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. }, ], + "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. + "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe. + "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). + "port": 42, # Optional. Specifies the port number on the container to which the request is sent. + }, + "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). + }, "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100]. "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10]. "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I. @@ -1241,6 +1299,16 @@Method Details
}, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config. + "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration. + "jsonConfig": { # Required. The value of the ADK config in JSON format. + "a_key": "", # Properties of the object. + }, + }, + "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config. + "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file. + }, + }, "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect. "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root. "dir": "A String", # Required. Directory, relative to the source root, in which to run the build. diff --git a/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.html new file mode 100644 index 0000000000..b72031ca41 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . semanticGovernancePolicies
+Instance Methods
++
+operations()+Returns the operations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.operations.html b/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.operations.html new file mode 100644 index 0000000000..292182150e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.semanticGovernancePolicies.operations.html @@ -0,0 +1,272 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . semanticGovernancePolicies . operations
+Instance Methods
+ +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.
++
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
++
+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.
+Method Details
+++ +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. + }, +}+++ +list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +Args: + name: string, The name of the operation's parent resource. (required) + filter: string, The standard list filter. + pageSize: integer, The standard list page size. + pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "nextPageToken": "A String", # The standard List next-page token. + "operations": [ # A list of operations that matches the specified filter in the request. + { # 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. + }, + }, + ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index d121616f15..2ba14b5d43 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -901,7 +901,7 @@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. + }, +}+Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1219,7 +1219,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1610,7 +1610,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -1839,7 +1839,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2160,7 +2160,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -2389,7 +2389,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. @@ -4570,7 +4570,7 @@Method Details
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 176e03b8b4..eeb90918b9 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -263,7 +263,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. @@ -790,7 +790,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. @@ -1403,7 +1403,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. @@ -1921,7 +1921,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. @@ -2437,7 +2437,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. @@ -2969,7 +2969,7 @@Method Details
}, ], "createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. - "credentialProviderPolicyDefault": "A String", # Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. + "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. diff --git a/docs/dyn/appengine_v1.apps.locations.html b/docs/dyn/appengine_v1.apps.locations.html index 5a2a1ef099..d7d527950b 100644 --- a/docs/dyn/appengine_v1.apps.locations.html +++ b/docs/dyn/appengine_v1.apps.locations.html @@ -82,7 +82,7 @@Instance Methods
Gets information about a location.
-
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -122,7 +122,7 @@Method Details
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/appengine_v1alpha.apps.locations.html b/docs/dyn/appengine_v1alpha.apps.locations.html index 66b75aae6b..25eb1677fe 100644 --- a/docs/dyn/appengine_v1alpha.apps.locations.html +++ b/docs/dyn/appengine_v1alpha.apps.locations.html @@ -82,7 +82,7 @@Instance Methods
Gets information about a location.
-
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -122,7 +122,7 @@Method Details
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/appengine_v1alpha.projects.locations.html b/docs/dyn/appengine_v1alpha.projects.locations.html index b684501c87..0fb9392f86 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -132,7 +132,7 @@Method Details
list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/appengine_v1beta.apps.locations.html b/docs/dyn/appengine_v1beta.apps.locations.html index 626deae627..d5e509fd49 100644 --- a/docs/dyn/appengine_v1beta.apps.locations.html +++ b/docs/dyn/appengine_v1beta.apps.locations.html @@ -82,7 +82,7 @@Instance Methods
Gets information about a location.
-
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -122,7 +122,7 @@Method Details
list(appsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/appengine_v1beta.projects.locations.html b/docs/dyn/appengine_v1beta.projects.locations.html index 775589ac23..828528521c 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.html +++ b/docs/dyn/appengine_v1beta.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -132,7 +132,7 @@Method Details
+list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/artifactregistry_v1.projects.locations.html b/docs/dyn/artifactregistry_v1.projects.locations.html index 262df33e20..4446667285 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.html @@ -90,15 +90,21 @@Instance Methods
Gets information about a location.
++
+getProjectConfig(name, x__xgafv=None)Retrieves the project configuration.
getVpcscConfig(name, x__xgafv=None)Retrieves the VPCSC Config for the Project.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
++
+updateProjectConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the project configuration.
updateVpcscConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the VPCSC Config for the Project.
@@ -135,6 +141,29 @@Method Details
}++getProjectConfig(name, x__xgafv=None)+Retrieves the project configuration. + +Args: + name: string, Required. The name of the project's logging configuration: projects/{project}/locations/{location}/projectConfig (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The Artifact Registry logging configurations that apply to a Project. + "name": "A String", # Identifier. The name of the project's configuration. Always of the form: projects/{project}/locations/{location}/projectConfig + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, +}+getVpcscConfig(name, x__xgafv=None)Retrieves the VPCSC Config for the Project. @@ -157,7 +186,7 @@Method Details
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) @@ -205,6 +234,41 @@Method Details
++updateProjectConfig(name, body=None, updateMask=None, x__xgafv=None)+Updates the project configuration. + +Args: + name: string, Identifier. The name of the project's configuration. Always of the form: projects/{project}/locations/{location}/projectConfig (required) + body: object, The request body. + The object takes the form of: + +{ # The Artifact Registry logging configurations that apply to a Project. + "name": "A String", # Identifier. The name of the project's configuration. Always of the form: projects/{project}/locations/{location}/projectConfig + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, +} + + updateMask: string, Optional. Field mask to support partial updates. See https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for more details. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The Artifact Registry logging configurations that apply to a Project. + "name": "A String", # Identifier. The name of the project's configuration. Always of the form: projects/{project}/locations/{location}/projectConfig + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, +}+updateVpcscConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the VPCSC Config for the Project. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.operations.html b/docs/dyn/artifactregistry_v1.projects.locations.operations.html index b90ec8cd3b..978c6a47d2 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.operations.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.operations.html @@ -74,6 +74,9 @@Artifact Registry API . projects . locations . operations
Instance Methods
++
+cancel(name, body=None, 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`.
Close httplib2 connections.
@@ -81,6 +84,30 @@Instance Methods
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.
Method Details
+++cancel(name, body=None, 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) + body: object, The request body. + The object takes the form of: + +{ # The request message for Operations.CancelOperation. +} + + 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); } +}+diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 88b8315ba5..3d7ff425bd 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -277,6 +277,14 @@close()Close httplib2 connections.diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html index d1df6aa0cf..fc6e5ec206 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html @@ -237,6 +237,10 @@Method Details
}, "mode": "A String", # Optional. The mode of the repository. "name": "A String", # The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. For each location in a project, repository names must be unique. + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, "registryUri": "A String", # Output only. The repository endpoint, for example: `us-docker.pkg.dev/my-proj/my-repo`. "remoteRepositoryConfig": { # Remote repository configuration. # Configuration specific for a Remote Repository. "aptRepository": { # Configuration for an Apt remote repository. # Specific settings for an Apt remote repository. @@ -482,6 +486,10 @@Method Details
}, "mode": "A String", # Optional. The mode of the repository. "name": "A String", # The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. For each location in a project, repository names must be unique. + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, "registryUri": "A String", # Output only. The repository endpoint, for example: `us-docker.pkg.dev/my-proj/my-repo`. "remoteRepositoryConfig": { # Remote repository configuration. # Configuration specific for a Remote Repository. "aptRepository": { # Configuration for an Apt remote repository. # Specific settings for an Apt remote repository. @@ -661,6 +669,10 @@Method Details
}, "mode": "A String", # Optional. The mode of the repository. "name": "A String", # The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. For each location in a project, repository names must be unique. + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, "registryUri": "A String", # Output only. The repository endpoint, for example: `us-docker.pkg.dev/my-proj/my-repo`. "remoteRepositoryConfig": { # Remote repository configuration. # Configuration specific for a Remote Repository. "aptRepository": { # Configuration for an Apt remote repository. # Specific settings for an Apt remote repository. @@ -809,6 +821,10 @@Method Details
}, "mode": "A String", # Optional. The mode of the repository. "name": "A String", # The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. For each location in a project, repository names must be unique. + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, "registryUri": "A String", # Output only. The repository endpoint, for example: `us-docker.pkg.dev/my-proj/my-repo`. "remoteRepositoryConfig": { # Remote repository configuration. # Configuration specific for a Remote Repository. "aptRepository": { # Configuration for an Apt remote repository. # Specific settings for an Apt remote repository. @@ -940,6 +956,10 @@Method Details
}, "mode": "A String", # Optional. The mode of the repository. "name": "A String", # The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. For each location in a project, repository names must be unique. + "platformLogsConfig": { # The platform logs config for a project or a repository. # Optional. Configuration for platform logs. + "loggingState": "A String", # Optional. The state of the platform logs: enabled or disabled. + "severityLevel": "A String", # Optional. The severity level for the logs. Logs will be generated if their severity level is >= than the value of the severity level mentioned here. + }, "registryUri": "A String", # Output only. The repository endpoint, for example: `us-docker.pkg.dev/my-proj/my-repo`. "remoteRepositoryConfig": { # Remote repository configuration. # Configuration specific for a Remote Repository. "aptRepository": { # Configuration for an Apt remote repository. # Specific settings for an Apt remote repository. diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html index 310933b817..9f3ce173f8 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
@@ -908,6 +916,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.html index 3648a39bb9..551c3d2bad 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
@@ -799,6 +806,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html index 7d1d3fe2ab..d7cc8367e7 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html @@ -244,7 +244,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -408,7 +408,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -494,7 +494,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -604,7 +604,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -679,7 +679,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -753,7 +753,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html index 6dbbd71334..4a977872a9 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html @@ -267,7 +267,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -457,7 +457,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -569,7 +569,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -686,7 +686,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -786,7 +786,7 @@Method Details
"dataLogsViewer": True or False, # Optional. Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, - "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index 28202a6ab2..ec15e97216 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -385,6 +385,9 @@Method Details
"enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time. "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other. "expireTime": "A String", # Optional. When this backup is automatically expired. + "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties. + "sourceInstance": "A String", # Output only. The source instance of the backup. + }, "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. @@ -679,6 +682,9 @@Method Details
"enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time. "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other. "expireTime": "A String", # Optional. When this backup is automatically expired. + "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties. + "sourceInstance": "A String", # Output only. The source instance of the backup. + }, "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. @@ -962,6 +968,9 @@Method Details
"enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time. "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other. "expireTime": "A String", # Optional. When this backup is automatically expired. + "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties. + "sourceInstance": "A String", # Output only. The source instance of the backup. + }, "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. @@ -1249,6 +1258,9 @@Method Details
"enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time. "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other. "expireTime": "A String", # Optional. When this backup is automatically expired. + "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties. + "sourceInstance": "A String", # Output only. The source instance of the backup. + }, "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html index eb9dd86fb1..8a53c6eef4 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html @@ -328,6 +328,10 @@Method Details
"sizeGb": "A String", # The size of the disk in GB. "type": "A String", # The type of the disk. }, + "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. + }, "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource. "location": "A String", # Location of the resource: //"global"/"unspecified". "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. @@ -469,6 +473,10 @@Method Details
"sizeGb": "A String", # The size of the disk in GB. "type": "A String", # The type of the disk. }, + "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. + }, "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource. "location": "A String", # Location of the resource: //"global"/"unspecified". "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. @@ -590,6 +598,10 @@Method Details
"sizeGb": "A String", # The size of the disk in GB. "type": "A String", # The type of the disk. }, + "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. + }, "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource. "location": "A String", # Location of the resource: //"global"/"unspecified". "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. diff --git a/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html b/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html index 62da8e12b1..73510c710a 100644 --- a/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html +++ b/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html @@ -138,6 +138,10 @@Method Details
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} }, + "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} + }, "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance @@ -197,6 +201,10 @@Method Details
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} }, + "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} + }, "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance @@ -245,6 +253,10 @@Method Details
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} }, + "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. + "instanceCreateTime": "A String", # Output only. The instance creation timestamp. + "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} + }, "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.html b/docs/dyn/baremetalsolution_v2.projects.locations.html index 85f6f55287..75d6e2deb3 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.html @@ -127,7 +127,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -166,7 +166,7 @@Method Details
@@ -479,6 +482,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/batch_v1.projects.locations.html b/docs/dyn/batch_v1.projects.locations.html index 2353cff8a0..03eaf633c8 100644 --- a/docs/dyn/batch_v1.projects.locations.html +++ b/docs/dyn/batch_v1.projects.locations.html @@ -97,7 +97,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -136,7 +136,7 @@Method Details
@@ -288,6 +289,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index 2ba5b4cbc1..6fbd470d1d 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -180,6 +180,7 @@Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -239,7 +240,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -347,7 +349,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. } accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. @@ -395,6 +397,7 @@Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -454,7 +457,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }Method Details
{ # Response format for a page of results when listing datasets. "datasets": [ # An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. { # A dataset resource with only a subset of fields, to be returned in a list of datasets. + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset. * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake. "datasetReference": { # Identifier for a dataset. # The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "projectId": "A String", # Optional. The ID of the project containing this dataset. @@ -494,6 +498,7 @@Method Details
"a_key": "A String", }, "location": "A String", # The geographic location where the dataset resides. + "type": "A String", # Output only. Same as `type` in `Dataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }, ], "etag": "A String", # Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request. @@ -565,6 +570,7 @@Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -624,7 +630,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. } accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. @@ -678,6 +684,7 @@Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -737,7 +744,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -858,7 +866,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -967,7 +976,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. } accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. @@ -1021,6 +1030,7 @@Method Details
}, }, ], + "catalogSource": "A String", # Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake "creationTime": "A String", # Output only. The time when this dataset was created, in milliseconds since the epoch. "datasetReference": { # Identifier for a dataset. # Required. A reference that identifies the dataset. "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1080,7 +1090,7 @@Method Details
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". }, ], - "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. + "type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. }Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -319,7 +327,7 @@Method Details
}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). @@ -533,6 +541,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -562,7 +578,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -725,6 +741,30 @@Method Details
"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "genAiStats": { # GenAi stats for the query job. # Output only. Statistics related to GenAI usage in the query. + "errorStats": { # Provides error statistics for the query job across all AI function calls. # Job level error stats across all GenAi functions + "errors": [ # A list of unique errors at query level (up to 5, truncated to 100 chars) + "A String", + ], + }, + "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + { # Provides statistics for each Ai function call within a query. + "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. + "message": "A String", # System generated message to provide insights into cost optimization state. + "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. + }, + "errorStats": { # Provides error statistics for a GenAi function call. # Error stats for the function. + "errors": [ # A list of unique errors at function level (up to 5, truncated to 100 chars). + "A String", + ], + "numFailedRows": "A String", # Number of failed rows processed by the function + }, + "functionName": "A String", # Name of the function. + "numProcessedRows": "A String", # Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. + "prompt": "A String", # User input prompt of the function (truncated to 20 chars). + }, + ], + }, "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. "disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query. "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason. @@ -1412,6 +1452,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1812,6 +1860,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1854,7 +1910,7 @@Method Details
}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). @@ -2068,6 +2124,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2097,7 +2161,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -2260,6 +2324,30 @@Method Details
"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "genAiStats": { # GenAi stats for the query job. # Output only. Statistics related to GenAI usage in the query. + "errorStats": { # Provides error statistics for the query job across all AI function calls. # Job level error stats across all GenAi functions + "errors": [ # A list of unique errors at query level (up to 5, truncated to 100 chars) + "A String", + ], + }, + "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + { # Provides statistics for each Ai function call within a query. + "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. + "message": "A String", # System generated message to provide insights into cost optimization state. + "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. + }, + "errorStats": { # Provides error statistics for a GenAi function call. # Error stats for the function. + "errors": [ # A list of unique errors at function level (up to 5, truncated to 100 chars). + "A String", + ], + "numFailedRows": "A String", # Number of failed rows processed by the function + }, + "functionName": "A String", # Name of the function. + "numProcessedRows": "A String", # Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. + "prompt": "A String", # User input prompt of the function (truncated to 20 chars). + }, + ], + }, "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. "disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query. "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason. @@ -2947,6 +3035,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3230,6 +3326,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3435,6 +3539,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3477,7 +3589,7 @@Method Details
}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). @@ -3691,6 +3803,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3720,7 +3840,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -3883,6 +4003,30 @@Method Details
"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "genAiStats": { # GenAi stats for the query job. # Output only. Statistics related to GenAI usage in the query. + "errorStats": { # Provides error statistics for the query job across all AI function calls. # Job level error stats across all GenAi functions + "errors": [ # A list of unique errors at query level (up to 5, truncated to 100 chars) + "A String", + ], + }, + "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + { # Provides statistics for each Ai function call within a query. + "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. + "message": "A String", # System generated message to provide insights into cost optimization state. + "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. + }, + "errorStats": { # Provides error statistics for a GenAi function call. # Error stats for the function. + "errors": [ # A list of unique errors at function level (up to 5, truncated to 100 chars). + "A String", + ], + "numFailedRows": "A String", # Number of failed rows processed by the function + }, + "functionName": "A String", # Name of the function. + "numProcessedRows": "A String", # Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. + "prompt": "A String", # User input prompt of the function (truncated to 20 chars). + }, + ], + }, "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. "disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query. "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason. @@ -4570,6 +4714,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -4941,6 +5093,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -4983,7 +5143,7 @@Method Details
}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). @@ -5197,6 +5357,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -5226,7 +5394,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -5389,6 +5557,30 @@Method Details
"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "genAiStats": { # GenAi stats for the query job. # Output only. Statistics related to GenAI usage in the query. + "errorStats": { # Provides error statistics for the query job across all AI function calls. # Job level error stats across all GenAi functions + "errors": [ # A list of unique errors at query level (up to 5, truncated to 100 chars) + "A String", + ], + }, + "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + { # Provides statistics for each Ai function call within a query. + "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. + "message": "A String", # System generated message to provide insights into cost optimization state. + "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. + }, + "errorStats": { # Provides error statistics for a GenAi function call. # Error stats for the function. + "errors": [ # A list of unique errors at function level (up to 5, truncated to 100 chars). + "A String", + ], + "numFailedRows": "A String", # Number of failed rows processed by the function + }, + "functionName": "A String", # Name of the function. + "numProcessedRows": "A String", # Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. + "prompt": "A String", # User input prompt of the function (truncated to 20 chars). + }, + ], + }, "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. "disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query. "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason. @@ -6076,6 +6268,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -6470,6 +6670,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -6512,7 +6720,7 @@Method Details
}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). @@ -6726,6 +6934,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -6755,7 +6971,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -6920,6 +7136,30 @@Method Details
"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "genAiStats": { # GenAi stats for the query job. # Output only. Statistics related to GenAI usage in the query. + "errorStats": { # Provides error statistics for the query job across all AI function calls. # Job level error stats across all GenAi functions + "errors": [ # A list of unique errors at query level (up to 5, truncated to 100 chars) + "A String", + ], + }, + "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + { # Provides statistics for each Ai function call within a query. + "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. + "message": "A String", # System generated message to provide insights into cost optimization state. + "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. + }, + "errorStats": { # Provides error statistics for a GenAi function call. # Error stats for the function. + "errors": [ # A list of unique errors at function level (up to 5, truncated to 100 chars). + "A String", + ], + "numFailedRows": "A String", # Number of failed rows processed by the function + }, + "functionName": "A String", # Name of the function. + "numProcessedRows": "A String", # Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. + "prompt": "A String", # User input prompt of the function (truncated to 20 chars). + }, + ], + }, "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. "disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query. "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason. @@ -7607,6 +7847,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -7987,6 +8235,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. diff --git a/docs/dyn/bigquery_v2.projects.html b/docs/dyn/bigquery_v2.projects.html index 222e30c048..f3823935ae 100644 --- a/docs/dyn/bigquery_v2.projects.html +++ b/docs/dyn/bigquery_v2.projects.html @@ -131,7 +131,7 @@Method Details
"etag": "A String", # A hash of the page of results. "kind": "bigquery#projectList", # The resource type of the response. "nextPageToken": "A String", # Use this token to request the next page of results. - "projects": [ # Projects to which the user has at least READ access. + "projects": [ # Projects to which the user has at least READ access. This field can be omitted if `totalItems` is 0. { # Information about a single project. "friendlyName": "A String", # A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string. "id": "A String", # An opaque ID of this project. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index 4c88ae57c7..8e9090dba6 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -164,6 +164,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. @@ -338,6 +350,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. @@ -453,6 +477,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. @@ -583,6 +619,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. @@ -833,6 +881,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. @@ -948,6 +1008,18 @@Method Details
"name": "A String", # Optional. The name of this argument. Can be absent for function return argument. }, ], + "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildDuration": "A String", # Output only. The time taken for the image build. Populated only after the build succeeds or fails. + "buildState": "A String", # Output only. The current build state of the routine. + "buildStateUpdateTime": "A String", # Output only. The time when the build state was updated last. + "errorResult": { # Error details. # Output only. A result object that will be present only if the build has failed. + "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. + "location": "A String", # Specifies where the error occurred, if present. + "message": "A String", # A human-readable description of the error. + "reason": "A String", # A short error code that summarizes the error. + }, + "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). "definitionBody": "A String", # Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 4ecf55e741..a43b26573c 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -302,6 +302,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -331,7 +339,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -459,6 +467,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -807,6 +823,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -836,7 +860,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -964,6 +988,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1253,6 +1285,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1282,7 +1322,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -1410,6 +1450,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1807,6 +1855,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1836,7 +1892,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -1964,6 +2020,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2254,6 +2318,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2283,7 +2355,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -2411,6 +2483,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2819,6 +2899,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2848,7 +2936,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -2976,6 +3064,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3266,6 +3362,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3295,7 +3399,7 @@Method Details
"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. - "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. 42, ], }, @@ -3423,6 +3527,14 @@Method Details
# Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. + "generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). + "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. + "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "stored": True or False, # Optional. Whether the generated column is stored in the table. + }, + "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. + }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.html index 7ad4e4fd8b..5d09d9102f 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.html @@ -95,7 +95,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -164,7 +164,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.html b/docs/dyn/bigtableadmin_v2.projects.instances.html index cadeb72576..f6d21db655 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.html @@ -176,6 +176,7 @@Method Details
"instance": { # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. # Required. The instance to create. Fields marked `OutputOnly` must be left blank. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, @@ -256,6 +257,7 @@Method Details
{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, @@ -349,6 +351,7 @@Method Details
{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, @@ -392,6 +395,7 @@Method Details
{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, @@ -562,6 +566,7 @@Method Details
{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, @@ -586,6 +591,7 @@Method Details
{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. "createTime": "A String", # Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. + "edition": "A String", # Optional. The edition of the instance. See Edition for details. "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. "a_key": "A String", }, diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index ece6e9c093..6444de439e 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -249,6 +249,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -457,6 +459,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -748,6 +752,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -1031,6 +1037,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -1230,6 +1238,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -1357,6 +1367,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -1524,6 +1536,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. @@ -1732,6 +1746,8 @@Method Details
"elementType": # Object with schema name: Type # The type of the elements in the array. This must not be `Array`. }, "boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool + "encoding": { # Defines rules used to convert to or from lower level types. # Specifies the encoding to use when converting to or from lower level types. + }, }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 5112b12e91..a81233eeb9 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -273,9 +273,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -665,9 +665,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -954,9 +954,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1203,9 +1203,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1431,9 +1431,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index cc36aa9666..c92f2cf6c0 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -83,6 +83,9 @@Instance Methods
runSession(session, body=None, x__xgafv=None)Initiates a single-turn interaction with the CES agent within a session.
++
+streamRunSession(session, body=None, x__xgafv=None)Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.
Method Details
+ +close()@@ -130,6 +133,276 @@Method Details
{ # Request message for SessionService.RunSession. "config": { # The configuration for the session. # Required. The configuration for the session. "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` + "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. + "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. + { # A message within a conversation. + "chunks": [ # Optional. Content of the message as a series of chunks. + { # A chunk of content within a message. + "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event. + "displayName": "A String", # Output only. Display name of the agent. + "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "payload": { # Optional. Custom payload data. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Optional. Text data. + "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "transcript": "A String", # Optional. Transcript associated with the audio. + "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + }, + ], + "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. + "role": "A String", # Optional. The role within the conversation, e.g., user, agent. + }, + ], + "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. + "audioEncoding": "A String", # Required. The encoding of the input audio data. + "noiseSuppressionLevel": "A String", # Optional. Whether to enable noise suppression on the input audio. Available values are "low", "moderate", "high", "very_high". + "sampleRateHertz": 42, # Required. The sample rate (in Hertz) of the input audio data. + }, + "outputAudioConfig": { # OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses. # Optional. Configuration for generating the output audio. + "audioEncoding": "A String", # Required. The encoding of the output audio data. + "sampleRateHertz": 42, # Required. The sample rate (in Hertz) of the output audio data. + }, + "remoteDialogflowQueryParameters": { # [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent. # Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent. + "endUserMetadata": { # Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "", # Properties of the object. + }, + "payload": { # Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "", # Properties of the object. + }, + "webhookHeaders": { # Optional. The HTTP headers to be sent as webhook_headers in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "A String", + }, + }, + "timeZone": "A String", # Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". + "useToolFakes": True or False, # Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools. + }, + "inputs": [ # Required. Inputs for the session. + { # Input for the session. + "audio": "A String", # Optional. Audio data from the end user. + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data from the end user. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "dtmf": "A String", # Optional. DTMF digits from the end user. + "event": { # Event input. # Optional. Event input. + "event": "A String", # Required. The name of the event. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "text": "A String", # Optional. Text data from the end user. + "toolResponses": { # Execution results for the requested tool calls from the client. # Optional. Execution results for the tool calls from the client. + "toolResponses": [ # Optional. The list of tool execution results. + { # The execution result of a specific tool from the client or the agent. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + }, + "variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters. + "a_key": "", # Properties of the object. + }, + "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal. + }, + ], +} + + 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 SessionService.RunSession. + "outputs": [ # Outputs for the session. + { # Output for the session. + "audio": "A String", # Output audio from the CES agent. + "citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. + "citedChunks": [ # List of cited pieces of information. + { # Piece of cited information. + "text": "A String", # Text used for citation. + "title": "A String", # Title of the cited document. + "uri": "A String", # URI used for citation. + }, + ], + }, + "diagnosticInfo": { # Contains execution details during the processing. # Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn. + "messages": [ # List of the messages that happened during the processing. + { # A message within a conversation. + "chunks": [ # Optional. Content of the message as a series of chunks. + { # A chunk of content within a message. + "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event. + "displayName": "A String", # Output only. Display name of the agent. + "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "payload": { # Optional. Custom payload data. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Optional. Text data. + "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "transcript": "A String", # Optional. Transcript associated with the audio. + "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + }, + ], + "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. + "role": "A String", # Optional. The role within the conversation, e.g., user, agent. + }, + ], + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, + }, + "endSession": { # Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent. # Indicates the session has ended. + "metadata": { # Optional. Provides additional information about the end session signal, such as the reason for ending the session. + "a_key": "", # Properties of the object. + }, + }, + "googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the GoogleSearchTool. + "htmls": [ # Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`. + "A String", + ], + "webSearchQueries": [ # List of queries used to perform the google search along with the search result URIs forming the search suggestions. + { # Represents a single web search query and its associated search uri. + "query": "A String", # The search query text. + "uri": "A String", # The URI to the Google Search results page for the query. + }, + ], + }, + "payload": { # Custom payload with structured output from the CES agent. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Output text from the CES agent. + "toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools. + "toolCalls": [ # Optional. The list of tool calls to execute. + { # Request for the client or the agent to execute the specified tool. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + }, + "turnCompleted": True or False, # If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn. + "turnIndex": 42, # Indicates the sequential order of conversation turn to which this output belongs to, starting from 1. + }, + ], +} ++streamRunSession(session, body=None, x__xgafv=None)+Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true. + +Args: + session: string, Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for SessionService.RunSession. + "config": { # The configuration for the session. # Required. The configuration for the session. + "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` + "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index e775f14632..d852d72983 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -516,7 +516,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -976,7 +981,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1462,7 +1472,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1935,7 +1950,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2412,7 +2432,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2872,7 +2897,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index 367fe365d1..90b1141f81 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -1432,7 +1432,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index f2c39aeeec..f307a8fe66 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -333,9 +333,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1028,7 +1028,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1440,9 +1445,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -2135,7 +2140,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2572,9 +2582,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -3267,7 +3277,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -3691,9 +3706,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -4386,7 +4401,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 30e3ac04bf..282a172c0b 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -326,9 +326,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -737,9 +737,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1096,9 +1096,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1364,9 +1364,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1611,9 +1611,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index af5f7cde1f..dc5da4701d 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -83,6 +83,9 @@Instance Methods
runSession(session, body=None, x__xgafv=None)Initiates a single-turn interaction with the CES agent within a session.
++
+streamRunSession(session, body=None, x__xgafv=None)Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.
Method Details
+ +close()@@ -130,6 +133,276 @@Method Details
{ # Request message for SessionService.RunSession. "config": { # The configuration for the session. # Required. The configuration for the session. "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` + "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. + "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. + { # A message within a conversation. + "chunks": [ # Optional. Content of the message as a series of chunks. + { # A chunk of content within a message. + "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event. + "displayName": "A String", # Output only. Display name of the agent. + "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "payload": { # Optional. Custom payload data. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Optional. Text data. + "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "transcript": "A String", # Optional. Transcript associated with the audio. + "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + }, + ], + "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. + "role": "A String", # Optional. The role within the conversation, e.g., user, agent. + }, + ], + "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. + "audioEncoding": "A String", # Required. The encoding of the input audio data. + "noiseSuppressionLevel": "A String", # Optional. Whether to enable noise suppression on the input audio. Available values are "low", "moderate", "high", "very_high". + "sampleRateHertz": 42, # Required. The sample rate (in Hertz) of the input audio data. + }, + "outputAudioConfig": { # OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses. # Optional. Configuration for generating the output audio. + "audioEncoding": "A String", # Required. The encoding of the output audio data. + "sampleRateHertz": 42, # Required. The sample rate (in Hertz) of the output audio data. + }, + "remoteDialogflowQueryParameters": { # [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent. # Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent. + "endUserMetadata": { # Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "", # Properties of the object. + }, + "payload": { # Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "", # Properties of the object. + }, + "webhookHeaders": { # Optional. The HTTP headers to be sent as webhook_headers in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). + "a_key": "A String", + }, + }, + "timeZone": "A String", # Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". + "useToolFakes": True or False, # Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools. + }, + "inputs": [ # Required. Inputs for the session. + { # Input for the session. + "audio": "A String", # Optional. Audio data from the end user. + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data from the end user. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "dtmf": "A String", # Optional. DTMF digits from the end user. + "event": { # Event input. # Optional. Event input. + "event": "A String", # Required. The name of the event. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "text": "A String", # Optional. Text data from the end user. + "toolResponses": { # Execution results for the requested tool calls from the client. # Optional. Execution results for the tool calls from the client. + "toolResponses": [ # Optional. The list of tool execution results. + { # The execution result of a specific tool from the client or the agent. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + }, + "variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters. + "a_key": "", # Properties of the object. + }, + "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal. + }, + ], +} + + 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 SessionService.RunSession. + "outputs": [ # Outputs for the session. + { # Output for the session. + "audio": "A String", # Output audio from the CES agent. + "citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. + "citedChunks": [ # List of cited pieces of information. + { # Piece of cited information. + "text": "A String", # Text used for citation. + "title": "A String", # Title of the cited document. + "uri": "A String", # URI used for citation. + }, + ], + }, + "diagnosticInfo": { # Contains execution details during the processing. # Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn. + "messages": [ # List of the messages that happened during the processing. + { # A message within a conversation. + "chunks": [ # Optional. Content of the message as a series of chunks. + { # A chunk of content within a message. + "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event. + "displayName": "A String", # Output only. Display name of the agent. + "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "payload": { # Optional. Custom payload data. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Optional. Text data. + "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "transcript": "A String", # Optional. Transcript associated with the audio. + "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + }, + ], + "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. + "role": "A String", # Optional. The role within the conversation, e.g., user, agent. + }, + ], + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, + }, + "endSession": { # Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent. # Indicates the session has ended. + "metadata": { # Optional. Provides additional information about the end session signal, such as the reason for ending the session. + "a_key": "", # Properties of the object. + }, + }, + "googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the GoogleSearchTool. + "htmls": [ # Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`. + "A String", + ], + "webSearchQueries": [ # List of queries used to perform the google search along with the search result URIs forming the search suggestions. + { # Represents a single web search query and its associated search uri. + "query": "A String", # The search query text. + "uri": "A String", # The URI to the Google Search results page for the query. + }, + ], + }, + "payload": { # Custom payload with structured output from the CES agent. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Output text from the CES agent. + "toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools. + "toolCalls": [ # Optional. The list of tool calls to execute. + { # Request for the client or the agent to execute the specified tool. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + }, + "turnCompleted": True or False, # If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn. + "turnIndex": 42, # Indicates the sequential order of conversation turn to which this output belongs to, starting from 1. + }, + ], +} ++diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html index 7203e145cd..a406ee067a 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.html +++ b/docs/dyn/cloudkms_v1.projects.locations.html @@ -123,7 +123,7 @@streamRunSession(session, body=None, x__xgafv=None)+Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true. + +Args: + session: string, Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for SessionService.RunSession. + "config": { # The configuration for the session. # Required. The configuration for the session. + "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` + "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index 36724936f6..edf52d8014 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -516,7 +516,12 @@@@ -281,6 +283,7 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -976,7 +981,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1462,7 +1472,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1935,7 +1950,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2412,7 +2432,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2872,7 +2897,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 78e8bde783..8e83dfe6ed 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -1432,7 +1432,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index d4e9b0b015..0d78c5e1b8 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -352,9 +352,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -1047,7 +1047,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -1478,9 +1483,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -2173,7 +2178,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -2629,9 +2639,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -3324,7 +3334,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. @@ -3767,9 +3782,9 @@Method Details
"gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. - "dataset": "A String", # Optional. The BigQuery dataset to export the data to. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. - "project": "A String", # Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. }, "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app. "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions. @@ -4462,7 +4477,12 @@Method Details
"a_key": "A String", }, "mode": "A String", # Optional. The mode of the data mapping. - "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. + "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. + "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. + "pythonCode": "A String", # Optional. The Python code to execute for the tool. + }, + "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` }, "description": "A String", # Optional. The description of the widget tool. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index d399de58bd..f18c26dd98 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -2942,7 +2942,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -5978,7 +5978,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -9032,7 +9032,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -12074,7 +12074,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -15121,7 +15121,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -18151,7 +18151,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -21181,7 +21181,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -24211,7 +24211,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 1d07eaf02c..a644dd8a47 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -3057,7 +3057,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -6082,7 +6082,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -9107,7 +9107,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -12130,7 +12130,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -15151,7 +15151,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -18172,7 +18172,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -21610,7 +21610,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -24635,7 +24635,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -27660,7 +27660,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -30683,7 +30683,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -33704,7 +33704,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -36725,7 +36725,7 @@Method Details
}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. diff --git a/docs/dyn/chat_v1.users.html b/docs/dyn/chat_v1.users.html index b00ac830d6..b363a6de3f 100644 --- a/docs/dyn/chat_v1.users.html +++ b/docs/dyn/chat_v1.users.html @@ -74,6 +74,11 @@Google Chat API . users
Instance Methods
++
+sections()+Returns the sections Resource.
+ diff --git a/docs/dyn/chat_v1.users.sections.html b/docs/dyn/chat_v1.users.sections.html new file mode 100644 index 0000000000..63314e4479 --- /dev/null +++ b/docs/dyn/chat_v1.users.sections.html @@ -0,0 +1,267 @@ + + + +Google Chat API . users . sections
+Instance Methods
++
+items()+Returns the items Resource.
+ ++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+ +[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
++
+position(name, body=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` + +Args: + parent: string, Required. The parent resource name where the section is created. Format: `users/{user}` (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. +}+++ +delete(name, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` + +Args: + name: string, Required. The name of the section to delete. Format: `users/{user}/sections/{section}` (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); } +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly` + +Args: + parent: string, Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}` (required) + pageSize: integer, Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error. + pageToken: string, Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. + 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 listing sections. [Developer Preview](https://developers.google.com/workspace/preview). + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "sections": [ # The sections from the specified user. + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. + }, + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ +patch(name, body=None, updateMask=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` + +Args: + name: string, Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. +} + + updateMask: string, Required. The mask to specify which fields to update. Currently supported field paths: - `display_name` + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. +}+++ + \ No newline at end of file diff --git a/docs/dyn/chat_v1.users.sections.items.html b/docs/dyn/chat_v1.users.sections.items.html new file mode 100644 index 0000000000..a17017ca4c --- /dev/null +++ b/docs/dyn/chat_v1.users.sections.items.html @@ -0,0 +1,166 @@ + + + +position(name, body=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` + +Args: + name: string, Required. The resource name of the section to position. Format: `users/{user}/sections/{section}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for positioning a section. [Developer Preview](https://developers.google.com/workspace/preview). + "relativePosition": "A String", # Optional. The relative position of the section in the list of sections. + "sortOrder": 42, # Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position. +} + + 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 positioning a section. [Developer Preview](https://developers.google.com/workspace/preview). + "section": { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). # The updated section. + "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. + "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` + "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. + "type": "A String", # Required. The type of the section. + }, +}+Google Chat API . users . sections . items
+Instance Methods
++
+close()Close httplib2 connections.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
+ +Retrieves the next page of results.
++
+move(name, body=None, x__xgafv=None)[Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+Method Details
+++ +close()+Close httplib2 connections.+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly` + +Args: + parent: string, Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}` (required) + filter: string, Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error. + pageSize: integer, Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error. + pageToken: string, Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. + 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 listing section items. [Developer Preview](https://developers.google.com/workspace/preview). + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "sectionItems": [ # The section items from the specified section. + { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. [Developer Preview](https://developers.google.com/workspace/preview). + "name": "A String", # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}` + "space": "A String", # Optional. The space resource name. Format: `spaces/{space}` + }, + ], +}+++ +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. ++++ + \ No newline at end of file diff --git a/docs/dyn/cloudbilling_v1beta.html b/docs/dyn/cloudbilling_v1beta.html index 429d054f12..e4525c2368 100644 --- a/docs/dyn/cloudbilling_v1beta.html +++ b/docs/dyn/cloudbilling_v1beta.html @@ -89,6 +89,11 @@move(name, body=None, x__xgafv=None)+[Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` + +Args: + name: string, Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for moving a section item across sections. [Developer Preview](https://developers.google.com/workspace/preview). + "targetSection": "A String", # Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}` +} + + 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 moving a section item. [Developer Preview](https://developers.google.com/workspace/preview). + "sectionItem": { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. [Developer Preview](https://developers.google.com/workspace/preview). # The updated section item. + "name": "A String", # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}` + "space": "A String", # Optional. The space resource name. Format: `spaces/{space}` + }, +}+Instance Methods
Returns the skus Resource.
++
+v1beta()+Returns the v1beta Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/cloudbilling_v1beta.v1beta.html b/docs/dyn/cloudbilling_v1beta.v1beta.html index 13c6dec090..7283df3889 100644 --- a/docs/dyn/cloudbilling_v1beta.v1beta.html +++ b/docs/dyn/cloudbilling_v1beta.v1beta.html @@ -78,8 +78,8 @@Instance Methods
close()Close httplib2 connections.
-
-estimateCostScenario(body=None, x__xgafv=None)Estimate list prices using a `CostScenario` without a defined `billingAccount`.
+generateInsights(body=None, x__xgafv=None)+Analyzes cost data for a billing account and/or specific projects. Returns a natural language summary and supporting datasets.
Method Details
close()@@ -87,354 +87,26 @@Method Details
-diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index 02c7086e1b..fd24f87902 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -186,6 +186,12 @@estimateCostScenario(body=None, x__xgafv=None)-Estimate list prices using a `CostScenario` without a defined `billingAccount`. +generateInsights(body=None, x__xgafv=None)+Analyzes cost data for a billing account and/or specific projects. Returns a natural language summary and supporting datasets. Args: body: object, The request body. The object takes the form of: -{ # Request for EstimateCostScenarioWithListPrice. - "costScenario": { # Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options. # The scenario to estimate costs for. - "commitments": [ # New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided. - { # Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts. - "name": "A String", # Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name may be at most 128 characters long. - "vmResourceBasedCud": { # Specifies a resource-based committed use discount (CUD). # A resource-based committed use discount (CUD). - "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerator, known as GPU. - "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance. - "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4". - }, - "machineSeries": "A String", # The machine series for CUD. For example: "n1" for general purpose N1 machine type commitments. "n2" for general purpose N2 machine type commitments. "e2" for general purpose E2 machine type commitments. "n2d" for general purpose N2D machine type commitments. "t2d" for general purpose T2D machine type commitments. "c2"/"c2d" for compute-optimized commitments. "m1"/"m2" for the memory-optimized commitments. "a2' for the accelerator-optimized commitments. - "memorySizeGb": 3.14, # Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). - "plan": "A String", # Commitment usage plan. - "region": "A String", # The region where the VM runs. For example: "us-central1" - "virtualCpuCount": "A String", # The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd. - }, - }, - ], - "scenarioConfig": { # Configuration for a CostScenario. Specifies how costs are calculated. # Configuration for the scenario. - "estimateDuration": "A String", # Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month. For durations longer than one month (2,628,000 seconds), the duration is rounded up to the next month, so the estimate shows you the costs for full months. For example, a duration of 3,232,800 seconds (roughly 5 weeks) is rounded up to 2 months. +{ # Request for GenerateInsights. + "filter": "A String", # Optional. Filters cost data by service id. Follows https://google.aip.dev/160 for the filter syntax. eg. filter: "service = 'C7E2-9256-1C43'" + "overriddenMaxIterationCounts": 42, # Optional. Overrides the maximum iterations for any selected strategy. + "parents": [ # Optional. The billing account or projects to analyze. + { # Specifies a Billing data resource that can be used for authorization to access billing data. + "billingAccount": "A String", # Optional. If not provided the billing account currently associated with the resource will be used. + "resource": "A String", # Required. Resource name for an entitity that can be used for authorization to access billing data such as `projects/{project}` or `billingAccounts/{billing_account}` }, - "workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided. - { # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed. - "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN Data Transfer. # Usage on Google Cloud CDN Data Transfer. - "cacheEgressDestination": "A String", # The destination for the cache data transfer. - "cacheEgressRate": { # An amount of usage over a time frame. # Cache data transfer usage. The rate of data cache transferred to the destination. Use units such as GiBy/s or TiBy/mo, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - }, - "cloudCdnWorkload": { # Specifies usage for Cloud CDN resources. # Usage on Google Cloud CDN. - "cacheFillOriginService": "A String", # The source service for the cache fill. - "cacheFillRate": { # An amount of usage over a time frame. # Cache fill usage. The rate of data transferred between cache fill regions. For example: units such as "GiBy/s" or "TBy/mo". - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "cacheFillRegions": { # Specifies the regions for Cache Fill. # The regions where data is transferred from Google data locations into Google global cache servers. The SKU prices for cache fill across services are the same. - "destinationRegion": "A String", # The destination region for cache fill. - "sourceRegion": "A String", # The source region for cache fill. - }, - "cacheLookUpRate": { # An amount of usage over a time frame. # Cache look up requests. This is specified to indicate the number of requests. For example: units such as "1/s". - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - }, - "cloudInterconnectEgressWorkload": { # Includes the estimate for Interconnect Data Transfer only. To specify usage for data transfer between VMs and internet end-points, use the Standard Tier Internet Data Transfer interface. # Usage on Google Cloud Interconnect Data Transfer. - "egressRate": { # An amount of usage over a time frame. # Outbound data transfer usage. This usage applies when you move or copy data from one Google Cloud service to another service. The units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). These are the Interconnect Data Transfer charges. - }, - "cloudInterconnectWorkload": { # Specifies usage for Cloud Interconnect resources. # Usage on Google Cloud Interconnect. - "interconnectAttachments": [ # VLAN attachment used for interconnect. - { # VLAN attachment for Cloud Interconnect. - "bandwidth": "A String", # Capacities in the [pricing table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing) Examples of capacity are: 50/100/200/300/400/500-Mbps, 1/2/5/10/20/50-Gbps. - "vlanCount": { # An amount of usage over a time frame. # VLAN usage. This is specified as a unitless quantity which indicates the number of VLAN attachment used in interconnect. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - }, - ], - "interconnectType": "A String", # VLAN attachment type - "linkType": "A String", # Interconnect circuit link type. - "provisionedLinkCount": { # An amount of usage over a time frame. # Interconnect usage. This is specified as a unitless quantity which indicates the number of circuit provisioned in interconnect. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - }, - "cloudStorageEgressWorkload": { # Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. * If transferring data between two regions, the source and destination fields are set to different values. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_SOUTH_AMERICA". * If transferring data within one region, the source and destination fields are set to the same value. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". Some examples for the Network data transfer traffic type on the pricing page. * Data moves between different locations on the same continent. `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and neither is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and one is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_AUSTRALIA". # Usage on Cloud Storage Data Transfer. - "destinationContinent": "A String", # Where the data is sent to. - "egressRate": { # An amount of usage over a time frame. # Data transfer usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. The expected units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "sourceContinent": "A String", # Where the data comes from. - }, - "cloudStorageWorkload": { # Specifies usage of Cloud Storage resources. # Usage on Google Cloud Storage. - "dataRetrieval": { # An amount of usage over a time frame. # Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as "GiB/s" or "B/s". - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "dataStored": { # An amount of usage over a time frame. # Data storage usage. The amount of data stored in buckets. For example: units such as GiBy/s or TiBy/mo, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "dualRegion": { # Area contains dual locations. # Specify dual regions. - "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "asia1" for dual region. - }, - "multiRegion": { # Area contains multiple locations. # Specify multi regions. - "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "us" for multi-region. - }, - "operationA": { # An amount of usage over a time frame. # Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s". - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "operationB": { # An amount of usage over a time frame. # Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s". - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "region": { # Area contains only one location. # Specify a single region. - "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: "us-central1" for region. - }, - "storageClass": "A String", # The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: "standard" and "nearline". - }, - "computeVmWorkload": { # Specificies usage of a set of identical compute VM instances. # Usage of a Google Compute Engine Virtual Machine. - "enableConfidentialCompute": True or False, # Defines whether each instance has confidential compute enabled. - "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerators attached to each machine. - "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance. - "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4". - }, - "instancesRunning": { # An amount of usage over a time frame. # VM usage. This is specified as a unitless quantity which indicates the number of instances running. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "licenses": [ # Premium image licenses used by each instance. - "A String", - ], - "machineType": { # Specification of machine series, memory, and number of vCPUs. # The machine type. - "customMachineType": { # Specification of a custom machine type. - "machineSeries": "A String", # Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: "n1". - "memorySizeGb": 3.14, # Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count. - "virtualCpuCount": "A String", # Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison). - }, - "predefinedMachineType": { # Specification of a predefined machine type. - "machineType": "A String", # The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: "n1-standard1". - }, - }, - "persistentDisks": [ # Persistent disks attached to each instance. Must include a boot disk. - { # Specification of a persistent disk attached to a VM. - "diskSize": { # An amount of usage over a time frame. # Specifies the size of disk. Must be at least 10 GB. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "diskType": "A String", # The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: "pd-standard". - "provisionedIops": { # An amount of usage over a time frame. # Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "scope": "A String", # The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified. - }, - ], - "preemptible": True or False, # Defines whether each instance is preemptible. - "region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1". - }, - "name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` may be at most 128 characters long. - "premiumTierEgressWorkload": { # Specify a Premium Tier Internet Data Transfer networking workload. # Usage on Premium Tier Internet Data Transfer. - "destinationContinent": "A String", # Where the data is sent to. - "egressRate": { # An amount of usage over a time frame. # Premium Tier Data Transfer usage. The expected units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data comes from. - }, - "standardTierEgressWorkload": { # Specify Standard Tier Internet Data Transfer. # Usage on Standard Tier Internet Data Transfer. - "egressRate": { # An amount of usage over a time frame. # Standard Tier Data Transfer usage. The expected units are GiBy/s, By/s, and so on, based on the [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from. - }, - "vmToVmEgressWorkload": { # Specify VM to VM data transfer. # Usage on VM to VM Data Transfer. - "interRegionEgress": { # Data transfer between two regions. - "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred to. - "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected units such are GiBy/s, By/s, and so on. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from. - }, - "intraRegionEgress": { # Data transfer within the same region. When the source region and destination region are in the same zone, using internal IP addresses, there isn't any charge for data transfer. - "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected are GiBy/s, By/s, and so on. - "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval. - "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s` - "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order. - { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval. - "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "usageRate": 3.14, # The usage rate. - }, - ], - }, - }, - }, - }, - }, - ], + ], + "prompt": "A String", # Required. The natural language prompt from the user. + "userContext": { # Additional context for personalization (e.g., user persona, role). # Optional. Additional context for personalization (e.g., user persona, role). + "persona": "A String", # Optional. The user's persona (e.g., FinOps Manager, Developer). + "role": "A String", # Optional. The user's role (e.g., Billing Admin, Project Owner, etc.). }, } @@ -446,184 +118,124 @@Method Details
Returns: An object of the form: - { # Response for EstimateCostScenarioWithListPrice - "costEstimationResult": { # The result of a estimating the costs of a `CostScenario`. # The result of the cost estimation. - "currencyCode": "A String", # Required. The ISO 4217 currency code for the cost estimate. - "segmentCostEstimates": [ # Required. Estimated costs for each idealized month of a `CostScenario`. - { # Workload cost estimates for a single time segment. - "commitmentCostEstimates": [ # Estimated costs for each commitment. - { # Estimated cost for a commitment. - "commitmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the commitment. - "creditEstimates": [ # The estimated credits applied. - { # An estimated credit applied to the costs on a SKU. - "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "creditDescription": "A String", # The credit description. - "creditType": "A String", # The credit type. - }, - ], - "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - }, - "name": "A String", # The name of the commitment, as specified in the `CostScenario`. - "skuCostEstimates": [ # Estimated costs for each SKU in the commitment. - { # Estimated cost for usage on a SKU. - "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU. - "creditEstimates": [ # The estimated credits applied. - { # An estimated credit applied to the costs on a SKU. - "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "creditDescription": "A String", # The credit description. - "creditType": "A String", # The credit type. - }, - ], - "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - }, - "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`. - "usageAmount": 3.14, # The amount of usage on this SKU. - "usageUnit": "A String", # The unit for the usage on this SKU. - }, - ], - }, - ], - "segmentStartTime": { # Represents a point in time. # Timestamp for the start of the segment. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "segmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the time segment. - "creditEstimates": [ # The estimated credits applied. - { # An estimated credit applied to the costs on a SKU. - "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "creditDescription": "A String", # The credit description. - "creditType": "A String", # The credit type. + { # Response for GenerateInsights. + "finalResult": { # Encapsulates all structured data and the completed summary. # Output only. The final structured results and metadata. Usually sent as the final message in the stream. + "dataSets": [ # Output only. Data sets used to support the insights, suitable for UI rendering (tables/charts). + { # A dataset used to support an insight, suitable for UI rendering (tables/charts). + "billingData": { # Encapsulates billing data. # Output only. Actual billing data returned from the Data Mart. Uses the formal message from the Billing Data Service. + "columnInfo": [ # Information about columns. + { # Represents a column header. + "column": "A String", # Name of the column. }, ], - "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - }, - "workloadCostEstimates": [ # Estimated costs for each workload. - { # Estimated cost for a workload. - "name": "A String", # The name of the workload, as specified in the `CostScenario`. - "skuCostEstimates": [ # Estimated costs for each SKU in the workload. - { # Estimated cost for usage on a SKU. - "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU. - "creditEstimates": [ # The estimated credits applied. - { # An estimated credit applied to the costs on a SKU. - "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + "rows": [ # Rows. + { # Represents a row in the query result. + "values": [ # Values for a row in the column order. + { # This is a copy of storage/googlesql/public/value.proto. ValueProto represents the serialized form of the googlesql::Value. The intention is to support multiple languages including Java and C++, so we must be sensitive to the distinction between Java Strings and byte arrays or ByteStrings. We also want to support use-cases which do not want to serialize a copy of the GoogleSQL type for every instance (which might be very repetitive). Therefore, unlike googlesql::Value, ValueProto does not carry full type information with every instance, and can only be fully interpreted with an associated TypeProto. + "ValueProtoSwitchMustHaveADefault": True or False, # User code that switches on this oneoff enum must have a default case so builds won't break when new fields are added. + "arrayValue": { # An ordered collection of elements of arbitrary count. # An array of value + "element": [ # The elements of the array. + # Object with schema name: ValueProto + ], + }, + "bignumericValue": "A String", # Encoded bignumeric value. For the encoding format see documentation for BigNumericValue::SerializeAsProtoBytes(). + "boolValue": True or False, # Primitive for bool. + "bytesValue": "A String", # Primitive for bytes. + "dateValue": 42, # Primitive for date. + "datetimeValue": { # A datetime value. # primitive for datetime + "bitFieldDatetimeSeconds": "A String", # Represents bit field encoding of year/month/day/hour/minute/second. See class DatetimeValue in civil_time.h for details of encoding. + "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. + }, + "doubleValue": 3.14, # Primitive for double. + "enumValue": 42, # Tag 11 was used for specifying micros timestamps as int64, now obsolete. + "floatValue": 3.14, # Primitive for float. + "geographyValue": "A String", # Geography encoded using ::stlib::STGeographyEncoder + "int32Value": 42, # Primitive value for int32. + "int64Value": "A String", # Primitive for int64. + "intervalValue": "A String", # Encoded interval value. For the encoding format see documentation for IntervalValue::SerializeAsBytes(). + "jsonValue": "A String", # Tag 22 was used for json value as bytes, now obsolete. Json value represented as a string document. + "mapValue": { # An unordered mapping from key to value, represented as a collection of map entries. # Encoded map value. See go/googlesql_map. + "entry": [ # Represents the map entries in the map. + { # A single entry in a Map, representing the mapping between `key` and `value`. + "key": # Object with schema name: ValueProto # Represents the serialized map key for the entry. + "value": # Object with schema name: ValueProto # Represents the serialized map value of the entry. }, - "creditDescription": "A String", # The credit description. - "creditType": "A String", # The credit type. - }, - ], - "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + ], }, - "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + "numericValue": "A String", # Encoded numeric value. For the encoding format see documentation for NumericValue::SerializeAsProtoBytes(). + "protoValue": "A String", # Stores a serialized protocol message. + "rangeValue": { # A range of values, bounded by the values 'start' (inclusive) and 'end' (exclusive). A range has an element type, and values must be of this element type. A range is contiguous, ie it contains all values of the given element type starting at 'start' and ending before 'end'. A "null" value on start or end represents an unbounded start or end value respectively. Start and end values must always be present. # Encoded range value. See go/googlesql_range. + "end": # Object with schema name: ValueProto # Represents the end of the range. + "start": # Object with schema name: ValueProto # Represents the start of the range. }, - }, - "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`. - "usageAmount": 3.14, # The amount of usage on this SKU. - "usageUnit": "A String", # The unit for the usage on this SKU. - }, - ], - "workloadTotalCostEstimate": { # An estimated cost. # Total estimated costs for the workload. - "creditEstimates": [ # The estimated credits applied. - { # An estimated credit applied to the costs on a SKU. - "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + "stringValue": "A String", # Primitive for string. + "structValue": { # A collection of fields. The count, order, and type of the fields is determined by the type associated with this value. # A struct of values + "field": [ # The fields in the struct + # Object with schema name: ValueProto + ], }, - "creditDescription": "A String", # The credit description. - "creditType": "A String", # The credit type. + "timeValue": "A String", # Bit field encoding of hour/minute/second/nanos. See TimeValue class for details. + "timestampPicoValue": "A String", # Encoded timestamp_pico value. For the encoding format see documentation for googlesql::TimestampPico::SerializeAsBytes(). + "timestampValue": "A String", # primitive for timestamp + "tokenlistValue": "A String", # Encoded tokenlist value. copybara:strip_begin(internal-comment) See //search/tokens:token_list. copybara:strip_end + "uint32Value": 42, # Primitive for uint32. + "uint64Value": "A String", # Primitive for uint64. + "uuidValue": "A String", # Encoded uuid value. For the encoding format see documentation for UuidValue::SerializeAsBytes(). }, ], - "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, }, - }, - ], + ], + }, + "queryInfo": { # A local representation of the query used to fetch the data. This is used instead of the raw QueryBillingDataRequest to avoid pulling in Cloud Policy Enforcement (CPE) resource_type annotations into the response payload, which causes ESF validation failures. # Output only. The query used to fetch this data. + "columns": "A String", # The columns queried. + "filter": "A String", # The filter applied to the query. + "groupBy": "A String", # The group-by clause applied to the query. + "limit": 42, # The row limit applied to the query. + "orderBy": "A String", # The order-by clause applied to the query. + "parents": [ # The parents (e.g. projects, billing accounts) queried. + "A String", + ], + "view": "A String", # The view queried. + }, + "suggestedChart": { # A suggested chart for the data set, used for UI rendering. # Output only. A suggested chart for the data set, used for UI rendering. + "chartTitle": "A String", # The title of the chart. + "chartType": "A String", # The type of the chart. + "seriesField": "A String", # The field used for the series (e.g., color-coding). Optional, but recommended for time-series data. + "xAxisField": "A String", # The field used for the x-axis. + "xAxisLabel": "A String", # The label of the x-axis. + "yAxisField": "A String", # The field used for the y-axis. + "yAxisLabel": "A String", # The label of the y-axis. + }, }, ], - "skus": [ # Required. Information about SKUs used in the estimate. - { # Information about SKUs appearing in the cost estimate. - "displayName": "A String", # The display name for the SKU. Example: A2 Instance Core running in Americas - "prices": [ # A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value. - { # The price of a SKU at a point int time. - "effectiveTime": { # Represents a point in time. # The timestamp within the estimation time frame when the price was set. - "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate. - }, - "priceType": "A String", # The type of price. Possible values: "RATE" - "rate": { # A SKU price consisting of tiered rates. # A set of tiered rates. - "tiers": [ # The service tiers. - { # Pricing details for a service tier. - "price": { # Represents an amount of money with its currency type. # The price for this tier. - "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. - "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - }, - "startAmount": 3.14, # The magnitude of usage in which the tier interval begins. Example: "From 100 GiBi the price is $1 per byte" implies `start_amount` = 100 - }, - ], - "unit": "A String", # The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit. - "unitCount": 3.14, # The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000. - }, - }, - ], - "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" + "fullAnalysis": "A String", # Output only. Contains the full natural language analysis, including thoughts, reasoning, and references. + "insights": [ # Output only. A list of discrete insights gleaned from the data. + { # e.g. insight: title: "Cost Increase (The Explanation)" description: "Your cost increase was driven by Vertex AI Online Prediction in us-central1..." severity: INFO + "description": "A String", # Output only. The description of the insight. + "severity": "A String", # Output only. The severity of the insight, used for UI rendering (e.g., color-coding). + "title": "A String", # Output only. The title of the insight. + }, + ], + "interopLinks": [ # Output only. Links to interoperable tools (e.g., pre-filtered Cost Reports or BQE queries). + { # A link to interoperable tools (e.g., pre-filtered Cost Reports, BQE queries). + "label": "A String", # Output only. The label of the link, suitable for UI rendering. + "linkType": "A String", # Output only. The type of the interop link, e.g., "COST_REPORT", "BQE_QUERY", etc. + "url": "A String", # Output only. The URL of the link. }, ], + "suggestedQueries": [ # Output only. A list of suggested follow-up queries for the user. + { # A suggested follow-up query for the user. + "query": "A String", # The natural language query. + }, + ], + "summary": "A String", # Output only. The full natural language summary (re-sent for consistency). + }, + "rejection": { # Encapsulates details about why a request was rejected. # Output only. The request was rejected (e.g. out of scope). + "displayMessage": "A String", # Output only. A user-facing message explaining the rejection. + "reason": "A String", # Output only. The reason for the rejection. }, + "summaryChunk": "A String", # Output only. A chunk of the natural language summary (customer-facing). The UI can append these chunks to provide a real-time "typing" effect. + "thoughtChunk": "A String", # Output only. A chunk of the agent's internal reasoning process. The UI can use this to render a "Thinking..." log or status. }Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -264,6 +270,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -339,6 +349,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -616,6 +654,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -694,6 +738,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -769,6 +817,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1077,6 +1153,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1155,6 +1237,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1230,6 +1316,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1513,6 +1627,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1591,6 +1711,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1666,6 +1790,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index b01df413bc..1369e52572 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -185,6 +185,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -263,6 +269,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -338,6 +348,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -615,6 +653,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -693,6 +737,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -768,6 +816,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1076,6 +1152,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1154,6 +1236,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1229,6 +1315,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1512,6 +1626,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1590,6 +1710,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1665,6 +1789,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 42c8c44ee6..a364db7cb5 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -174,6 +174,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -252,6 +258,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -327,6 +337,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -787,6 +825,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -865,6 +909,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -940,6 +988,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1428,6 +1504,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1506,6 +1588,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1581,6 +1667,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -2053,6 +2167,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -2131,6 +2251,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -2206,6 +2330,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -2683,6 +2835,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -2761,6 +2919,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -2836,6 +2998,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -3298,6 +3488,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -3376,6 +3572,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -3451,6 +3651,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 088aa158ca..98b5b8689e 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -174,6 +174,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -252,6 +258,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -327,6 +337,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -787,6 +825,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -865,6 +909,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -940,6 +988,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -1428,6 +1504,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -1506,6 +1588,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -1581,6 +1667,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -2053,6 +2167,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -2131,6 +2251,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -2206,6 +2330,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -2684,6 +2836,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -2762,6 +2920,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -2837,6 +2999,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. @@ -3297,6 +3487,12 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "genericArtifacts": [ # Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE. + { # Generic artifact to upload to Artifact Registry upon successful completion of all build steps. + "folder": "A String", # Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. + "registryPath": "A String", # Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION + }, + ], "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 @@ -3375,6 +3571,10 @@Method Details
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. { # A dependency that the Cloud Build worker will fetch before executing user steps. "empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well). + "genericArtifact": { # Represents a generic artifact as a build dependency. # Represents a generic artifact as a build dependency. + "destPath": "A String", # Required. Where the artifact files should be placed on the worker. + "resource": "A String", # Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, "gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency. "depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history). "destPath": "A String", # Required. Where should the files be placed on the worker. @@ -3450,6 +3650,34 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. + { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. + "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. + "fileHashes": { # Output only. The file hashes that make up the generic artifact. + "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1 + }, + ], "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. "artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. diff --git a/docs/dyn/cloudbuild_v2.projects.locations.html b/docs/dyn/cloudbuild_v2.projects.locations.html index d038dfd4ea..812834db18 100644 --- a/docs/dyn/cloudbuild_v2.projects.locations.html +++ b/docs/dyn/cloudbuild_v2.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
@@ -226,6 +227,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.html b/docs/dyn/cloudfunctions_v1.projects.locations.html index 5dd4a49ddb..ed53615792 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.html @@ -84,7 +84,7 @@Instance Methods
Close httplib2 connections.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -96,7 +96,7 @@Method Details
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html index 9a61fbf02c..2c62a4d2dc 100644 --- a/docs/dyn/cloudkms_v1.projects.html +++ b/docs/dyn/cloudkms_v1.projects.html @@ -152,6 +152,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.html b/docs/dyn/cloudfunctions_v2.projects.locations.html index a59cdf1638..df24ced773 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.html @@ -94,7 +94,7 @@Instance Methods
Close httplib2 connections.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -106,7 +106,7 @@Method Details
@@ -128,6 +129,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.html index b6ad339ee7..83901337fd 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.html @@ -94,7 +94,7 @@Instance Methods
Close httplib2 connections.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -106,7 +106,7 @@Method Details
diff --git a/docs/dyn/cloudkms_v1.organizations.html b/docs/dyn/cloudkms_v1.organizations.html index a448f610ef..8a4afaa42b 100644 --- a/docs/dyn/cloudkms_v1.organizations.html +++ b/docs/dyn/cloudkms_v1.organizations.html @@ -109,6 +109,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.html index 296755de01..975e802974 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.html @@ -94,7 +94,7 @@Instance Methods
Close httplib2 connections.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -106,7 +106,7 @@Method Details
@@ -192,6 +193,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 2140ac324f..dece1463c1 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -138,6 +138,7 @@Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". } @@ -210,6 +212,7 @@Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". } @@ -146,6 +148,7 @@Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }, }Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". } @@ -299,6 +302,7 @@Method Details
"A String", ], }, + "defaultPolicyAvailable": True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details. "name": "A String", # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". }Instance Methods
Returns the EkmConfig singleton resource for a given project and location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -213,7 +213,7 @@Method Details
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html index 114773d0f0..262ce0aaa5 100644 --- a/docs/dyn/compute_alpha.advice.html +++ b/docs/dyn/compute_alpha.advice.html @@ -80,6 +80,9 @@Instance Methods
capacity(project, region, body=None, x__xgafv=None)Advice on making real-time decisions (such as choosing zone or
++
+capacityHistory(project, region, body=None, x__xgafv=None)Gets the capacity history for Spot VMs.
Close httplib2 connections.
@@ -241,6 +244,24 @@Method Details
# The key is an arbitrary, unique RFC1035 string that identifies the # instance selection. "a_key": { # Machine specification. + "disks": [ # Local SSDs. + { + "type": "A String", # Specifies the type of the disk. + # This field must be set to SCRATCH. + }, + ], + "guestAccelerators": [ # Accelerators configuration. + { # A specification of the type and number of accelerator cards attached to the + # instance. + "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. + "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this + # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 + # If you are creating an instance template, specify only the + # accelerator name. + # See GPUs on Compute Engine + # for a full list of accelerator types. + }, + ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". "A String", ], @@ -307,6 +328,111 @@Method Details
}++capacityHistory(project, region, body=None, x__xgafv=None)+Gets the capacity history for Spot VMs. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region for this request. (required) + body: object, The request body. + The object takes the form of: + +{ # A request to get the capacity history for Spot VMs. + "instanceProperties": { + "machineType": "A String", # The machine type for the VM, such as `n2-standard-4`. + "scheduling": { + "provisioningModel": "A String", # The provisioning model to get capacity history for. + # This field must be set to SPOT. + # + # For more information, see + # Compute Engine instances provisioning models. + }, + }, + "locationPolicy": { + "location": "A String", # The region or zone to get capacity history for. + # + # It can be a partial or full URL. For example, the following are valid + # values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone + # - projects/project/zones/zone + # - zones/zone + # + # + # + # This field is optional. + }, + "types": [ + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Contains the capacity history for Spot VMs. + "location": "A String", + "machineType": "A String", + "preemptionHistory": [ + { + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + # Timestamp end (exclusive). + # + # The start must be less than or equal to the end. + # When the start equals the end, the interval is empty (matches no time). + # When both start and end are unspecified, the interval matches any time. + "endTime": "A String", # Optional. Exclusive end of the interval. + # + # If specified, a Timestamp matching this interval will have to be before the + # end. + "startTime": "A String", # Optional. Inclusive start of the interval. + # + # If specified, a Timestamp matching this interval will have to be the same + # or after the start. + }, + "preemptionRate": 3.14, + }, + ], + "priceHistory": [ + { + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + # Timestamp end (exclusive). + # + # The start must be less than or equal to the end. + # When the start equals the end, the interval is empty (matches no time). + # When both start and end are unspecified, the interval matches any time. + "endTime": "A String", # Optional. Exclusive end of the interval. + # + # If specified, a Timestamp matching this interval will have to be before the + # end. + "startTime": "A String", # Optional. Inclusive start of the interval. + # + # If specified, a Timestamp matching this interval will have to be the same + # or after the start. + }, + "listPrice": { # Represents an amount of money with its currency type. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. + # The value must be between -999,999,999 and +999,999,999 inclusive. + # If `units` is positive, `nanos` must be positive or zero. + # If `units` is zero, `nanos` can be positive, zero, or negative. + # If `units` is negative, `nanos` must be negative or zero. + # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. + # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + }, + ], +}+@@ -6612,59 +6620,59 @@close()Close httplib2 connections.diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html index 086962001f..0919358c7d 100644 --- a/docs/dyn/compute_alpha.autoscalers.html +++ b/docs/dyn/compute_alpha.autoscalers.html @@ -457,6 +457,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -1214,6 +1222,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -1586,6 +1602,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -2334,6 +2358,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -2757,6 +2789,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -3449,6 +3489,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 6cf583a9e7..8db5b0f254 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -985,7 +985,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -1433,7 +1433,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -1593,7 +1593,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -3425,7 +3425,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -3873,7 +3873,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -4033,7 +4033,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -6387,7 +6387,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -6835,7 +6835,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -6995,7 +6995,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -8525,7 +8525,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -8973,7 +8973,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -9133,7 +9133,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -10411,7 +10411,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -10859,7 +10859,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -11019,7 +11019,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -12240,7 +12240,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -12688,7 +12688,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -12848,7 +12848,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -15800,7 +15800,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -16248,7 +16248,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -16408,7 +16408,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index e72d1c107d..e16daf030f 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -751,6 +751,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2290,6 +2291,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3352,6 +3354,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4414,6 +4417,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5412,6 +5416,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -8841,6 +8846,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.hosts.html b/docs/dyn/compute_alpha.hosts.html new file mode 100644 index 0000000000..dc7c896bb4 --- /dev/null +++ b/docs/dyn/compute_alpha.hosts.html @@ -0,0 +1,640 @@ + + + +Compute Engine API . hosts
+Instance Methods
++
+close()Close httplib2 connections.
++
+get(project, zone, association, host, x__xgafv=None)Retrieves information about the specified host.
++
+getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)Allows customers to get SBOM versions of a host.
+ +Retrieves a list of hosts.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +get(project, zone, association, host, x__xgafv=None)+Retrieves information about the specified host. + +Args: + project: string, The project ID for this request. (required) + zone: string, The name of the zone for this request, formatted as RFC1035. (required) + association: string, The parent resource association for the Host. This field specifies the +hierarchical context (e.g., reservation, block, sub-block) when +accessing the host. For example, reservations/reservation_name, +reservations/reservation_name/reservationBlocks/reservation_block_name or +reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required) + host: string, The name of the host, formatted as RFC1035 or a resource ID +number. (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 host resource. + "aliasLinks": [ # Output only. All aliases for this resource. + # e.g. + # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1 + "A String", + ], + "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text. + "description": "A String", # An optional description of this resource. + "id": "A String", # Output only. The unique identifier for this resource. This identifier is + # defined by the server. + "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts. + "name": "A String", # Output only. The name of the host. + "selfLink": "A String", # Output only. The self link of the host. + "selfLinkWithId": "A String", # Output only. The self link with id of the host. + "state": "A String", # Output only. The state of the host. + "status": { # Output only. The status of the host + "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if + # present + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. + }, + "runningInstances": [ # Output only. The URIs of the instances currently running on this host. + "A String", + ], + }, + "zone": "A String", # Output only. The zone in which the host resides. +}+++ +getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)+Allows customers to get SBOM versions of a host. + +Args: + project: string, Project ID for this request. (required) + zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required) + association: string, The parent resource association for the Host. This field specifies the +hierarchical context (e.g., reservation, block, sub-block) when +accessing the host. (required) + host: string, The name of the host, formatted as RFC1035 or a resource ID +number. (required) + body: object, The request body. + The object takes the form of: + +{ + "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored. + "A String", + ], +} + + requestId: string, 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. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/alpha/globalOperations) + # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) + # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # 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). + "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. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}+++ +list(project, zone, association, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Retrieves a list of hosts. + +Args: + project: string, The project ID for this request. (required) + zone: string, The name of the zone for this request, formatted as RFC1035. (required) + association: string, The parent resource association for the Host. This field specifies the +hierarchical context (e.g., reservation, block, sub-block) when +accessing the host. For example, reservations/reservation_name, +reservations/reservation_name/reservationBlocks/reservation_block_name or +reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required) + filter: string, A filter expression that filters resources listed in the response. Most +Compute resources support two types of filter expressions: +expressions that support regular expressions and expressions that follow +API improvement proposal AIP-160. +These two types of filter expressions cannot be mixed in one request. + +If you want to use AIP-160, your expression must specify the field name, an +operator, and the value that you want to use for filtering. The value +must be a string, a number, or a boolean. The operator +must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. + +For example, if you are filtering Compute Engine instances, you can +exclude instances named `example-instance` by specifying +`name != example-instance`. + +The `:*` comparison can be used to test whether a key has been defined. +For example, to find all objects with `owner` label use: +``` +labels.owner:* +``` + +You can also filter nested fields. For example, you could specify +`scheduling.automaticRestart = false` to include instances only +if they are not scheduled for automatic restarts. You can use filtering +on nested fields to filter based onresource labels. + +To filter on multiple expressions, provide each separate expression within +parentheses. For example: +``` +(scheduling.automaticRestart = true) +(cpuPlatform = "Intel Skylake") +``` +By default, each expression is an `AND` expression. However, you +can include `AND` and `OR` expressions explicitly. +For example: +``` +(cpuPlatform = "Intel Skylake") OR +(cpuPlatform = "Intel Broadwell") AND +(scheduling.automaticRestart = true) +``` + +If you want to use a regular expression, use the `eq` (equal) or `ne` +(not equal) operator against a single un-parenthesized expression with or +without quotes or against multiple parenthesized expressions. Examples: + +`fieldname eq unquoted literal` +`fieldname eq 'single quoted literal'` +`fieldname eq "double quoted literal"` +`(fieldname1 eq literal) (fieldname2 ne "literal")` + +The literal value is interpreted as a regular expression using GoogleRE2 library syntax. +The literal value must match the entire field. + +For example, to filter for instances that do not end with name "instance", +you would use `name ne .*instance`. + +You cannot combine constraints on multiple fields using regular +expressions. + maxResults: integer, The maximum number of results per page that should be returned. +If the number of available results is larger than `maxResults`, +Compute Engine returns a `nextPageToken` that can be used to get +the next page of results in subsequent list requests. Acceptable values are +`0` to `500`, inclusive. (Default: `500`) + orderBy: string, Sorts list results by a certain order. By default, results +are returned in alphanumerical order based on the resource name. + +You can also sort results in descending order based on the creation +timestamp using `orderBy="creationTimestamp desc"`. This sorts +results based on the `creationTimestamp` field in +reverse chronological order (newest result first). Use this to sort +resources like operations so that the newest operation is returned first. + +Currently, only sorting by `name` or +`creationTimestamp desc` is supported. + pageToken: string, Specifies a page token to use. Set `pageToken` to the +`nextPageToken` returned by a previous list request to get +the next page of results. + returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case +of failure. The default value is false. + +For example, when partial success behavior is enabled, aggregatedList for a +single zone scope either returns all resources in the zone or no resources, +with an error code. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "etag": "A String", + "id": "A String", # The unique identifier for the resource; defined by the server. + "items": [ # A list of host resources. + { # Represents a host resource. + "aliasLinks": [ # Output only. All aliases for this resource. + # e.g. + # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1 + "A String", + ], + "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text. + "description": "A String", # An optional description of this resource. + "id": "A String", # Output only. The unique identifier for this resource. This identifier is + # defined by the server. + "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts. + "name": "A String", # Output only. The name of the host. + "selfLink": "A String", # Output only. The self link of the host. + "selfLinkWithId": "A String", # Output only. The self link with id of the host. + "state": "A String", # Output only. The state of the host. + "status": { # Output only. The status of the host + "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if + # present + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. + }, + "runningInstances": [ # Output only. The URIs of the instances currently running on this host. + "A String", + ], + }, + "zone": "A String", # Output only. The zone in which the host resides. + }, + ], + "kind": "compute#host", # The type of resource. Always compute#host for a list of hosts. + "nextPageToken": "A String", # This token allows you to get the next page of results for + # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + # the query parameter pageToken in the next list request. + # Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + "selfLink": "A String", # The server-defined URL for this resource. + "unreachables": [ # Unreachable resources. + # end_interface: MixerListResponseWithEtagBuilder + "A String", + ], + "warning": { # An informational warning message. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, +}+++ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 0d539679e9..cd92b4ae10 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -199,6 +199,11 @@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. ++Instance Methods
Returns the healthChecks Resource.
++
+hosts()+Returns the hosts Resource.
+ diff --git a/docs/dyn/compute_alpha.imageFamilyViews.html b/docs/dyn/compute_alpha.imageFamilyViews.html index 80bc5d2c2a..23768336ef 100644 --- a/docs/dyn/compute_alpha.imageFamilyViews.html +++ b/docs/dyn/compute_alpha.imageFamilyViews.html @@ -189,6 +189,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html index d35a01bc67..f117c3e6b3 100644 --- a/docs/dyn/compute_alpha.images.html +++ b/docs/dyn/compute_alpha.images.html @@ -852,6 +852,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1407,6 +1408,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2322,6 +2324,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3252,6 +3255,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3849,6 +3853,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html index 491f0b43e0..0d0bc21314 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html @@ -729,11 +729,11 @@Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -805,8 +805,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -829,7 +828,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -848,16 +847,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -954,14 +951,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -1079,7 +1076,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. } @@ -1108,11 +1105,11 @@Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -1184,8 +1181,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -1208,7 +1204,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -1227,16 +1223,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -1333,14 +1327,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -1458,7 +1452,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. } @@ -1860,11 +1854,11 @@Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -1936,8 +1930,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -1960,7 +1953,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -1979,16 +1972,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -2085,14 +2076,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -2210,7 +2201,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. }, diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 3b5e97fdac..d68624188c 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -715,59 +715,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -798,7 +798,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -924,6 +924,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1003,6 +1004,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1423,6 +1425,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1502,6 +1505,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1814,7 +1818,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -1874,7 +1878,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -1912,11 +1916,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -1968,22 +1972,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -2080,20 +2084,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -2190,79 +2194,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -2454,7 +2458,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). }, ], @@ -4610,59 +4614,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -4693,7 +4697,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -4819,6 +4823,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4898,6 +4903,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5318,6 +5324,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5397,6 +5404,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5709,7 +5717,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -5769,7 +5777,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -5807,11 +5815,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -5863,22 +5871,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -5975,20 +5983,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -6085,79 +6093,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -6349,7 +6357,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). }Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -6695,7 +6703,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -6821,6 +6829,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -6900,6 +6909,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7320,6 +7330,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7399,6 +7410,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7711,7 +7723,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -7771,7 +7783,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -7809,11 +7821,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -7865,22 +7877,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -7977,20 +7989,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -8087,79 +8099,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -8351,7 +8363,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } @@ -8841,59 +8853,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -8924,7 +8936,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -9050,6 +9062,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9129,6 +9142,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9549,6 +9563,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9628,6 +9643,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9940,7 +9956,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -10000,7 +10016,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -10038,11 +10054,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -10094,22 +10110,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -10206,20 +10222,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -10316,79 +10332,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -10580,7 +10596,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). }, ], @@ -11068,6 +11084,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11147,6 +11164,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11778,6 +11796,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11857,6 +11876,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -12546,59 +12566,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -12629,7 +12649,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -12755,6 +12775,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -12834,6 +12855,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -13254,6 +13276,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -13333,6 +13356,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -13645,7 +13669,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -13705,7 +13729,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -13743,11 +13767,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -13799,22 +13823,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -13911,20 +13935,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -14021,79 +14045,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -14285,7 +14309,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } @@ -18367,59 +18391,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -18450,7 +18474,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -18576,6 +18600,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -18655,6 +18680,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -19075,6 +19101,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -19154,6 +19181,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -19466,7 +19494,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -19526,7 +19554,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -19564,11 +19592,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -19620,22 +19648,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -19732,20 +19760,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -19842,79 +19870,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -20106,7 +20134,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 62dd7ec5f5..4fe5f60e04 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -416,6 +416,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -495,6 +496,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1965,6 +1967,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2044,6 +2047,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3499,6 +3503,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3578,6 +3583,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5043,6 +5049,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5122,6 +5129,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index fc6b4a02e3..84a9d29319 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -1715,6 +1715,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1794,6 +1795,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3238,6 +3240,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3317,6 +3320,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4044,6 +4048,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4123,6 +4128,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4586,6 +4592,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4665,6 +4672,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7242,6 +7250,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7321,6 +7330,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -10437,6 +10447,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -10516,6 +10527,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -12324,6 +12336,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -12403,6 +12416,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -23146,6 +23160,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -23225,6 +23240,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 93a6ebde60..fdbc29f8c1 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -594,6 +594,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -673,6 +674,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1803,6 +1805,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2853,6 +2856,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2932,6 +2936,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4062,6 +4067,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5118,6 +5124,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5197,6 +5204,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -6327,6 +6335,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html index a20ef8762c..abbe8b7e17 100644 --- a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html +++ b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html @@ -81,7 +81,7 @@Instance Methods
get(organization, x__xgafv=None)Returns the specified SnapshotRecycleBinPolicy.
-
+patch(organization, body=None, requestId=None, updateMask=None, x__xgafv=None)patch(organization, body=None, requestId=None, x__xgafv=None)Patches the SnapshotRecycleBinPolicy.
Method Details
@@ -130,7 +130,7 @@Method Details
-@@ -4462,59 +4466,59 @@patch(organization, body=None, requestId=None, updateMask=None, x__xgafv=None)+patch(organization, body=None, requestId=None, x__xgafv=None)Patches the SnapshotRecycleBinPolicy. Args: @@ -176,7 +176,6 @@@@ -1106,11 +1103,11 @@Method Details
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, update_mask indicates fields to be updated as part of this request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.recoverableSnapshots.html b/docs/dyn/compute_alpha.recoverableSnapshots.html index 8dc56d28d3..f0411dc8b5 100644 --- a/docs/dyn/compute_alpha.recoverableSnapshots.html +++ b/docs/dyn/compute_alpha.recoverableSnapshots.html @@ -281,6 +281,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -993,6 +994,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1778,6 +1780,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html index 994efa26d1..95dbcfe911 100644 --- a/docs/dyn/compute_alpha.regionAutoscalers.html +++ b/docs/dyn/compute_alpha.regionAutoscalers.html @@ -652,6 +652,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -1024,6 +1032,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -1772,6 +1788,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -2194,6 +2218,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. @@ -2886,6 +2918,14 @@Method Details
# default value of "UTC" if left empty. }, }, + "stabilizationPeriodSec": 42, # The number of seconds that autoscaler waits for load stabilization before + # making scale-in decisions. This is referred to as the + # [stabilization period](/compute/docs/autoscaler#stabilization_period). + # This might appear as a delay in scaling in but it is an important mechanism + # for your application to not have fluctuating size due to short term load + # fluctuations. + # + # The default stabilization period is 600 seconds. }, "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 20de580017..10205024ce 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -858,7 +858,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -1306,7 +1306,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -1466,7 +1466,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -3047,7 +3047,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -3495,7 +3495,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -3655,7 +3655,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -5186,7 +5186,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -5634,7 +5634,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -5794,7 +5794,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -7075,7 +7075,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -7523,7 +7523,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -7683,7 +7683,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -8905,7 +8905,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -9353,7 +9353,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -9513,7 +9513,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # @@ -12169,7 +12169,7 @@Method Details
# # This field is applicable to either: # - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -12617,7 +12617,7 @@Method Details
# metrics to use for computing the weights are specified via thecustomMetrics field. # # This field is applicable to either: - # - A regional backend service with the service_protocol set to HTTP, + # - A regional backend service with the service protocol set to HTTP, # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to # INTERNAL_MANAGED. # - A global backend service with the @@ -12777,7 +12777,7 @@Method Details
# - A global backend service with the loadBalancingScheme set to # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. # - A regional backend - # service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and + # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not # supported for Serverless NEGs. # diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index 349298645d..881016fe79 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -851,6 +851,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1913,6 +1914,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2972,6 +2974,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3970,6 +3973,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7396,6 +7400,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html index cc4100f9e6..f1788d29cc 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html @@ -729,11 +729,11 @@Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -805,8 +805,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -829,7 +828,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -848,16 +847,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -954,14 +951,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -1079,7 +1076,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. }Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -1182,8 +1179,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -1206,7 +1202,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -1225,16 +1221,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -1331,14 +1325,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -1456,7 +1450,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. } @@ -1859,11 +1853,11 @@Method Details
# InstanceGroupManager. "count": 42, # This field is deprecated, please use resize_by instead. # The count of instances to create as part of this resize request. - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this resize request inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server - # generates this identifier. + "id": "A String", # Output only. A unique identifier for this resource type. The server generates this + # identifier. "instances": [ # The names of instances to be created by this resize request. The number of # names specified determines the number of instances to create. The group's # target size will be increased by this number. This field cannot be used @@ -1935,8 +1929,7 @@Method Details
# managed instance. }, ], - "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for - # resize requests. + "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned @@ -1959,7 +1952,7 @@Method Details
"validUntilTime": "A String", # Absolute deadline for waiting for capacity inRFC3339 # text format. }, - "region": "A String", # Output only. [Output Only] The URL of aregion + "region": "A String", # Output only. The URL of a region # where the resize request is located. Populated only for regional resize # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. @@ -1978,16 +1971,14 @@Method Details
"resizeBy": 42, # The number of instances to be created by this resize request. The group's # target size will be increased by this number. This field cannot be used # together with 'instances'. - "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines - # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "state": "A String", # Output only. [Output only] Current state of the request. - "status": { # Output only. [Output only] Status of the request. - "error": { # Output only. [Output only] Fatal errors encountered during the queueing or - # provisioning phases of the ResizeRequest that caused the transition to - # the FAILED state. Contrary to the last_attempt errors, this field is - # final and errors are never removed from here, as the ResizeRequest is not - # going to retry. + "selfLink": "A String", # Output only. The URL for this resize request. The server defines this URL. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. + "state": "A String", # Output only. Current state of the request. + "status": { # Output only. Status of the request. + "error": { # Output only. Fatal errors encountered during the queueing or provisioning phases of + # the ResizeRequest that caused the transition to the FAILED state. + # Contrary to the last_attempt errors, this field is final and errors are + # never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -2084,14 +2075,14 @@Method Details
}, ], }, - "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request. - # The value is temporary since the ResizeRequest can retry, as long as it's - # still active and the last attempt value can either be cleared or replaced - # with a different error. Since ResizeRequest retries infrequently, the - # value may be stale and no longer show an active problem. The value is - # cleared when ResizeRequest transitions to the final state (becomes - # inactive). If the final state is FAILED the error describing it will be - # storred in the "error" field only. + "lastAttempt": { # Output only. Information about the last attempt to fulfill the request. The value is + # temporary since the ResizeRequest can retry, as long as it's still active + # and the last attempt value can either be cleared or replaced with a + # different error. Since ResizeRequest retries infrequently, the value may + # be stale and no longer show an active problem. The value is cleared when + # ResizeRequest transitions to the final state (becomes inactive). If the + # final state is FAILED the error describing it will be stored in the + # "error" field only. "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. @@ -2209,7 +2200,7 @@Method Details
# text format. }, }, - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of a zone # where the resize request is located. Populated only for zonal resize # requests. }, diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 0d6d66515b..dd0ba46b38 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -2603,59 +2603,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -2686,7 +2686,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -2812,6 +2812,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -2891,6 +2892,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3311,6 +3313,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3390,6 +3393,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3702,7 +3706,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -3762,7 +3766,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -3800,11 +3804,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -3856,22 +3860,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -3968,20 +3972,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -4078,79 +4082,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -4342,7 +4346,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). }Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -4545,7 +4549,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -4671,6 +4675,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -4750,6 +4755,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5170,6 +5176,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5249,6 +5256,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -5561,7 +5569,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -5621,7 +5629,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -5659,11 +5667,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -5715,22 +5723,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -5827,20 +5835,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -5937,79 +5945,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -6201,7 +6209,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } @@ -6690,59 +6698,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -6773,7 +6781,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -6899,6 +6907,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -6978,6 +6987,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7398,6 +7408,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7477,6 +7488,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -7789,7 +7801,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -7849,7 +7861,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -7887,11 +7899,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -7943,22 +7955,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -8055,20 +8067,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -8165,79 +8177,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -8429,7 +8441,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). }, ], @@ -8912,6 +8924,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -8991,6 +9004,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9622,6 +9636,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -9701,6 +9716,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -10387,59 +10403,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -10470,7 +10486,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -10596,6 +10612,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -10675,6 +10692,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11095,6 +11113,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11174,6 +11193,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -11486,7 +11506,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -11546,7 +11566,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -11584,11 +11604,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -11640,22 +11660,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -11752,20 +11772,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -11862,79 +11882,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -12126,7 +12146,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } @@ -16174,59 +16194,59 @@Method Details
# "vm-###" results in "vm-001" as a VM name. # @pattern # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) - "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339 + "creationTimestamp": "A String", # Output only. The creation timestamp for this managed instance group inRFC3339 # text format. - "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances + "currentActions": { # Output only. The list of instance actions and the number of instances # in this managed instance group that are scheduled for each of those # actions. - "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group + "abandoning": 42, # Output only. The total number of instances in the managed instance group # that are scheduled to be abandoned. Abandoning an instance removes it # from the managed instance group without deleting it. - "adopting": 42, # [Output Only] The number of instances in the managed instance group that + "adopting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be adopted or are currently being adopted. - "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "creating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be created or are currently being created. If the group # fails to create any of these instances, it tries again until it creates # the instance successfully. # # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. - "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingAtomically": 42, # Output only. The number of instances that the managed instance group # will attempt to create atomically, in a batch mode. If the desired count # of instances can not be created, entire batch will be deleted and the # group will decrease its targetSize value accordingly. - "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group + "creatingWithoutRetries": 42, # Output only. The number of instances that the managed instance group # will attempt to create. The group attempts to create each instance # only once. If the group fails to create any of these instances, it # decreases the group's targetSize value accordingly. - "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "deleting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be deleted or are currently being deleted. - "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "none": 42, # Output only. The number of instances in the managed instance group that # are running and have no scheduled actions. - "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group + "queuing": 42, # Output only. The number of instances that the managed instance group # is currently queuing. - "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "recreating": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be recreated or are currently being being recreated. # Recreating an instance deletes the existing root persistent disk # and creates a new disk from the image that is defined in the # instance template. - "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "refreshing": 42, # Output only. The number of instances in the managed instance group that # are being reconfigured with properties that do not require a restart # or a recreate action. For example, setting or removing target # pools for the instance. - "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. - "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. - "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "starting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be started or are currently being started. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "stopping": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be stopped or are currently being stopped. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "suspending": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be suspended or are currently being suspended. - "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that + "verifying": 42, # Output only. The number of instances in the managed instance group that # are being verified. See the managedInstances[].currentAction # property in the listManagedInstances method documentation. }, @@ -16257,7 +16277,7 @@Method Details
# # To see the latest fingerprint, make a get() request to # retrieve an InstanceGroupManager. - "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server + "id": "A String", # Output only. A unique identifier for this resource type. The server # generates this identifier. "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple # types of machines. @@ -16383,6 +16403,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -16462,6 +16483,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -16882,6 +16904,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -16961,6 +16984,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -17273,7 +17297,7 @@Method Details
# the capacity above standard_capacity_base. }, }, - "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource. + "instanceGroup": "A String", # Output only. The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application @@ -17333,7 +17357,7 @@Method Details
# instance group. The group uses this template to create all new instances # in the managed instance group. The templates for existing instances in the # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. - "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. + "kind": "compute#instanceGroupManager", # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for # this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. @@ -17371,11 +17395,11 @@Method Details
# - projects/project/regions/region/resourcePolicies/resourcePolicy # - regions/region/resourcePolicies/resourcePolicy }, - "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use. - "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. - "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. + "selfLink": "A String", # Output only. The URL for this managed instance group. The server defines # this URL. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "selfLinkWithId": "A String", # Output only. Server-defined URL for this resource with the resource id. "serviceAccount": "A String", # The service account to be used as credentials for all operations performed # by the managed instance group on instances. The service accounts needs all # permissions required to create and delete instances. @@ -17427,22 +17451,22 @@Method Details
}, }, }, - "status": { # Output only. [Output Only] The status of this managed instance group. - "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group. - "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision. + "status": { # Output only. The status of this managed instance group. + "allInstancesConfig": { # Output only. Status of all-instances configuration on the group. + "currentRevision": "A String", # Output only. Current all-instances configuration revision. # This value is in RFC3339 text format. - "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has + "effective": True or False, # Output only. A bit indicating whether this configuration has # been applied to all managed instances in the group. }, - "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + "appliedAcceleratorTopologies": [ # Output only. The accelerator topology applied to this MIG. # Currently only one accelerator topology is supported. { - "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + "acceleratorTopology": "A String", # Output only. Topology in the format of: "16x16", "4x4x4", etc. # The value is the same as configured in the WorkloadPolicy. - "state": "A String", # Output only. [Output Only] The state of the accelerator topology. - "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + "state": "A String", # Output only. The state of the accelerator topology. + "stateDetails": { # Output only. The result of the latest accelerator topology state # check. - "error": { # Output only. [Output Only] Encountered errors. + "error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -17539,20 +17563,20 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + "timestamp": "A String", # Output only. Timestamp is shown only if there is an error. The field # has // RFC3339 // # text format. }, }, ], - "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler + "autoscaler": "A String", # Output only. The URL of theAutoscaler # that targets this instance group manager. - "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation. # targetSizePolicy.mode is set to BULK. - "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. - "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + "inProgress": True or False, # Output only. Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. Information from the last progress check of bulk instance # operation. - "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. { @@ -17649,79 +17673,79 @@Method Details
}, ], }, - "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + "timestamp": "A String", # Output only. Timestamp of the last progress check of bulk instance # operation. Timestamp is in RFC3339 text format. }, }, - "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances # in this managed instance group that have the status. Currently only shown # for TPU MIGs # instance group that have the status. For more information about how to # interpret each status check the instance lifecycle documentation. # Currently only shown for TPU MIGs. - "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "deprovisioning": 42, # Output only. The number of instances in the managed instance group # that have DEPROVISIONING status. - "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + "nonExistent": 42, # Output only. The number of instances that have not been created yet or # have been deleted. Includes only instances that would be shown in the # listManagedInstances method and not all instances that have been # deleted in the lifetime of the MIG. # Does not include FlexStart instances that are waiting for the resources # availability, they are considered as 'pending'. - "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pending": 42, # Output only. The number of instances in the managed instance group # that have PENDING status, that is FlexStart instances that are waiting # for resources. Instances that do not exist because of the other reasons # are counted as 'non_existent'. - "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + "pendingStop": 42, # Output only. The number of instances in the managed instance group # that have PENDING_STOP status. - "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + "provisioning": 42, # Output only. The number of instances in the managed instance group # that have PROVISIONING status. - "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + "repairing": 42, # Output only. The number of instances in the managed instance group # that have REPAIRING status. - "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + "running": 42, # Output only. The number of instances in the managed instance group # that have RUNNING status. - "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + "staging": 42, # Output only. The number of instances in the managed instance group # that have STAGING status. - "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopped": 42, # Output only. The number of instances in the managed instance group # that have STOPPED status. - "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + "stopping": 42, # Output only. The number of instances in the managed instance group # that have STOPPING status. - "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspended": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDED status. - "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + "suspending": 42, # Output only. The number of instances in the managed instance group # that have SUSPENDING status. - "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + "terminated": 42, # Output only. The number of instances in the managed instance group # that have TERMINATED status. }, - "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a + "isStable": True or False, # Output only. A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for # example, creation, restart, or deletion); no future changes are scheduled # for instances in the managed instance group; and the managed instance # group itself is not being modified. - "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager. - "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "stateful": { # Output only. Stateful status of the given Instance Group Manager. + "hasStatefulConfig": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. - "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group + "isStateful": True or False, # Output only. A bit indicating whether the managed instance group # has stateful configuration, that is, if you have configured any items # in a stateful policy or in per-instance configs. # The group might report that it has no stateful configuration even when # there is still some preserved state on a managed instance, for example, # if you have deleted all PICs but not yet applied those deletions. This # field is deprecated in favor of has_stateful_config. - "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances. + "perInstanceConfigs": { # Output only. Status of per-instance configurations on the instances. "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations # (listed in the output of a listPerInstanceConfigs API call) have # status EFFECTIVE or there are no per-instance-configs. }, }, - "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their + "versionTarget": { # Output only. A status of consistency of Instances' versions with their # target version specified by version field on Instance Group # Manager. - "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached + "isReached": True or False, # Output only. A bit indicating whether version target has been reached # in this managed instance group, i.e. all instances are in their target # version. Instances' target version are specified byversion field on Instance Group Manager. }, @@ -17913,7 +17937,7 @@Method Details
}, }, ], - "zone": "A String", # Output only. [Output Only] The URL of azone + "zone": "A String", # Output only. The URL of azone # where the managed instance group is located (for zonal resources). } diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 93ed9ff677..ca2573d390 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -606,6 +606,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -685,6 +686,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1770,6 +1772,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1849,6 +1852,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3315,6 +3319,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -3394,6 +3399,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index c3d739e4a0..5d2f864984 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -230,6 +230,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -309,6 +310,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -772,6 +774,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -851,6 +854,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html index 215e0c4ed1..d94df8fe0f 100644 --- a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html +++ b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html @@ -477,6 +477,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1265,6 +1266,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index 8156777339..041d688cbb 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -476,6 +476,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1185,6 +1186,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see @@ -1901,6 +1903,7 @@Method Details
# - TDX_CAPABLE # - IDPF # - SNP_SVSM_CAPABLE + # - CCA_CAPABLE # # # For more information, see diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index 60f438b40c..feb8faf8c4 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -3966,6 +3966,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -7582,6 +7588,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -11884,6 +11896,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -15551,6 +15569,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -19476,6 +19500,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -23369,6 +23399,12 @@Method Details
# You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "status": { # [Output Only] The status of the URL map. # Output only. [Output Only] The status of the URL map. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, + }, "tests": [ # The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a # maximum of 100 tests per UrlMap. # @@ -23435,6 +23471,10 @@Method Details
], "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. # If false, 'loadErrors' indicates the reasons. + "quotaUsage": { # Message representing the quota usage for a UrlMap. # Output only. Summary of quota usage for given UrlMap. + "forwardingRules": 42, # Output only. The number of forwarding rules that uses this UrlMap. + "units": "A String", # Output only. The number of quota units calculated for this UrlMap. + }, "testFailures": [ { "actualOutputUrl": "A String", # The actual output URL evaluated by a load balancer containing the scheme, diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html index 9af2ce1381..15cb09716f 100644 --- a/docs/dyn/compute_alpha.rollouts.html +++ b/docs/dyn/compute_alpha.rollouts.html @@ -98,6 +98,9 @@Instance Methods
resume(project, rollout, etag=None, requestId=None, x__xgafv=None)Resumes a Rollout.
++
+startNextWave(project, rollout, requestId=None, waveNumber=None, x__xgafv=None)Starts the next wave of a Rollout.
Method Details
+cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)@@ -1627,4 +1630,298 @@Method Details
}++startNextWave(project, rollout, requestId=None, waveNumber=None, x__xgafv=None)+Starts the next wave of a Rollout. + +Args: + project: string, Required. Project ID for this request. (required) + rollout: string, Required. Name of the Rollout resource to start next wave. (required) + requestId: string, 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. + +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). + waveNumber: string, Required. Wave number of the current wave. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/alpha/globalOperations) + # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) + # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # 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). + "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. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}+