From b846444fa1128992c84ea1e11842dd28ce35794a Mon Sep 17 00:00:00 2001
From: Yoshi Automation Retrieves the next page of results.
+ Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.
Retrieves relevant contexts for a query.Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
@@ -465,6 +466,7 @@ Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
@@ -678,6 +680,7 @@ Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
@@ -850,6 +853,7 @@ Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
@@ -1021,6 +1025,7 @@ Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
@@ -1193,6 +1198,7 @@ Method Details
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
+ "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
index e6b0dc06b8b..4338efab776 100644
--- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
@@ -4671,7 +4671,7 @@
}
}
},
-"revision": "20250707",
+"revision": "20250804",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
@@ -5840,6 +5840,23 @@ false
"description": "The Chrome device's operating system version.",
"type": "string"
},
+"osVersionCompliance": {
+"description": "Output only. Compliance status of the OS version.",
+"enum": [
+"complianceUnspecified",
+"compliant",
+"pending",
+"notCompliant"
+],
+"enumDescriptions": [
+"Compliance status unspecified.",
+"Compliance status compliant.",
+"Compliance status pending.",
+"Compliance status not compliant."
+],
+"readOnly": true,
+"type": "string"
+},
"platformVersion": {
"description": "The Chrome device's platform version.",
"type": "string"
From a48a595c231bdbe183ecec01fa63419526597a97 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1209,6 +1213,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -1574,6 +1579,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1969,6 +1978,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index d436bca0ef8..85e65c73e01 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -1761,6 +1761,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2156,6 +2160,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -3998,6 +4003,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -4393,6 +4402,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html
index bfd39232391..70aa7598ba5 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.html
@@ -595,8 +595,10 @@ Method Details
},
},
"endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.
- "dedicatedEndpointEnabled": True or False, # Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
+ "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.
+ "dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
+ "endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
},
"huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.
"modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
index e6d4fcb9bbb..07a20020688 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
@@ -818,6 +818,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1213,6 +1217,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -1806,6 +1811,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2201,6 +2210,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
index 1b9fe701cef..53fc25a8049 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
@@ -138,12 +138,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -261,12 +277,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -326,12 +358,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -396,12 +444,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html
index 5beb45f435d..8cefb6ebf3f 100644
--- a/docs/dyn/aiplatform_v1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.publishers.models.html
@@ -812,6 +812,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1207,6 +1211,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -2145,6 +2150,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2540,6 +2549,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html
index 95829579d28..f15b920eeaf 100644
--- a/docs/dyn/aiplatform_v1.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.reasoningEngines.html
@@ -132,12 +132,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -256,12 +272,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -321,12 +353,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -391,12 +439,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index e0c60d1a50d..032a2babc0b 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -835,6 +835,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1241,6 +1245,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -1614,6 +1619,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2020,6 +2029,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index 1ce1c7160d3..a78375ef11f 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -1956,6 +1956,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2362,6 +2366,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -4401,6 +4406,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -4807,6 +4816,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html
index d32a8c4a8ae..f62c794953e 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html
@@ -337,6 +337,9 @@ Instance Methods
recommendSpec(parent, body=None, x__xgafv=None)retrieveContexts(parent, body=None, x__xgafv=None)Method Details
},
},
"endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.
- "dedicatedEndpointEnabled": True or False, # Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
+ "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.
+ "dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
+ "endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
},
"huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.
"modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used.
@@ -1881,6 +1886,326 @@ Method Details
+recommendSpec(parent, body=None, x__xgafv=None)
+ Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.
+
+Args:
+ parent: string, Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ModelService.RecommendSpec.
+ "checkMachineAvailability": True or False, # Optional. If true, check machine availability for the recommended regions. Only return the machine spec in regions where the machine is available.
+ "checkUserQuota": True or False, # Optional. If true, check user quota for the recommended regions. Returns all the machine spec in regions they are available, and also the user quota state for each machine type in each region.
+ "gcsUri": "A String", # Required. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model).
+}
+
+ 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 ModelService.RecommendSpec.
+ "baseModel": "A String", # Output only. The base model used to finetune the custom model.
+ "recommendations": [ # Output only. Recommendations of deployment options for the given custom weights model.
+ { # Recommendation of one deployment option for the given custom weights model in one region. Contains the machine and container spec, and user accelerator quota state.
+ "region": "A String", # The region for the deployment spec (machine).
+ "spec": { # A machine and model container spec. # Output only. The machine and model container specs.
+ "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Output only. The model container spec.
+ "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ "A String",
+ ],
+ "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ "A String",
+ ],
+ "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
+ "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ { # Represents an environment variable present in a Container or Python Module.
+ "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
+ "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
+ },
+ ],
+ "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
+ { # Represents a network port in a container.
+ "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
+ },
+ ],
+ "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
+ "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
+ "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
+ "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ { # Represents a network port in a container.
+ "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
+ },
+ ],
+ "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
+ "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
+ "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ },
+ "machineSpec": { # Specification of a single machine. # Output only. The machine spec.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
+ },
+ "userQuotaState": "A String", # Output only. The user accelerator quota state.
+ },
+ ],
+ "specs": [ # Output only. The machine and model container specs.
+ { # A machine and model container spec.
+ "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Output only. The model container spec.
+ "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ "A String",
+ ],
+ "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ "A String",
+ ],
+ "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
+ "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ { # Represents an environment variable present in a Container or Python Module.
+ "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
+ "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
+ },
+ ],
+ "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
+ { # Represents a network port in a container.
+ "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
+ },
+ ],
+ "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
+ "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
+ "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
+ "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
+ { # Represents a network port in a container.
+ "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
+ },
+ ],
+ "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
+ "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
+ "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
+ "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
+ "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ "A String",
+ ],
+ },
+ "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
+ "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
+ "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+ "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
+ },
+ "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
+ "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
+ "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+ { # HttpHeader describes a custom header to be used in HTTP probes
+ "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ "value": "A String", # The header field value
+ },
+ ],
+ "path": "A String", # Path to access on the HTTP server.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
+ },
+ "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
+ "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
+ "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
+ "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
+ "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
+ "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
+ },
+ "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
+ },
+ },
+ "machineSpec": { # Specification of a single machine. # Output only. The machine spec.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
+ },
+ ],
+}
+retrieveContexts(parent, body=None, x__xgafv=None)
Retrieves relevant contexts for a query.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
index a4dc74bc158..08feb511f26 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
@@ -923,6 +923,10 @@
Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1329,6 +1333,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -2017,6 +2022,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -2423,6 +2432,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
index 6241a2ae254..a9abc2ebbe5 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
@@ -165,7 +165,7 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
- "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus.
+ "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
"apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
@@ -398,7 +398,7 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
- "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus.
+ "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
"apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
@@ -572,7 +572,7 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
- "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus.
+ "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
"apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
@@ -752,7 +752,7 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
- "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus.
+ "ragFilesCount": 42, # Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
"apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
index 32211db82e2..01d1b35846f 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
@@ -168,12 +168,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -301,12 +317,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -376,12 +408,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -456,12 +504,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
index 54abf0918f7..f69f23d7175 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html
@@ -125,11 +125,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}
@@ -325,11 +327,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
},
],
@@ -396,11 +402,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}
@@ -474,11 +482,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
},
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html
index d57617e590f..80f48158e06 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html
@@ -207,6 +207,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
index 31a45e96d70..705f0449a1d 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
@@ -216,6 +216,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
index fc4f6d9e297..3a494fd8599 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
@@ -173,6 +173,21 @@ Method Details
],
"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.
},
+ "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job.
+ { # Evaluate Dataset Run Result for Tuning Job.
+ "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
+ "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). # Output only. The error of the evaluation run if any.
+ "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.
+ },
+ "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.
+ },
+ ],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
@@ -193,6 +208,51 @@ Method Details
"tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
},
"preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
"adapterSize": "A String", # Optional. Adapter size for preference optimization.
"beta": 3.14, # Optional. Weight for KL Divergence regularization.
@@ -208,6 +268,51 @@ Method Details
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
@@ -236,6 +341,12 @@ Method Details
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -340,6 +451,12 @@ Method Details
},
},
"preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example.
"buckets": [ # Output only. Defines the histogram bucket.
{ # Dataset bucket used to create a histogram for the distribution given a population of values.
@@ -628,6 +745,7 @@ Method Details
},
},
},
+ "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running).
"updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
"veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning.
"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo.
@@ -679,6 +797,21 @@ Method Details
],
"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.
},
+ "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job.
+ { # Evaluate Dataset Run Result for Tuning Job.
+ "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
+ "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). # Output only. The error of the evaluation run if any.
+ "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.
+ },
+ "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.
+ },
+ ],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
@@ -699,6 +832,51 @@ Method Details
"tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
},
"preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
"adapterSize": "A String", # Optional. Adapter size for preference optimization.
"beta": 3.14, # Optional. Weight for KL Divergence regularization.
@@ -714,6 +892,51 @@ Method Details
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
@@ -742,6 +965,12 @@ Method Details
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -846,6 +1075,12 @@ Method Details
},
},
"preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example.
"buckets": [ # Output only. Defines the histogram bucket.
{ # Dataset bucket used to create a histogram for the distribution given a population of values.
@@ -1134,6 +1369,7 @@ Method Details
},
},
},
+ "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running).
"updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
"veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning.
"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo.
@@ -1192,6 +1428,21 @@ Method Details
],
"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.
},
+ "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job.
+ { # Evaluate Dataset Run Result for Tuning Job.
+ "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
+ "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). # Output only. The error of the evaluation run if any.
+ "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.
+ },
+ "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.
+ },
+ ],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
@@ -1212,6 +1463,51 @@ Method Details
"tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
},
"preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
"adapterSize": "A String", # Optional. Adapter size for preference optimization.
"beta": 3.14, # Optional. Weight for KL Divergence regularization.
@@ -1227,6 +1523,51 @@ Method Details
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
@@ -1255,6 +1596,12 @@ Method Details
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -1359,6 +1706,12 @@ Method Details
},
},
"preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example.
"buckets": [ # Output only. Defines the histogram bucket.
{ # Dataset bucket used to create a histogram for the distribution given a population of values.
@@ -1647,6 +2000,7 @@ Method Details
},
},
},
+ "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running).
"updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
"veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning.
"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo.
@@ -1711,6 +2065,21 @@ Method Details
],
"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.
},
+ "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job.
+ { # Evaluate Dataset Run Result for Tuning Job.
+ "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
+ "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). # Output only. The error of the evaluation run if any.
+ "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.
+ },
+ "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.
+ },
+ ],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
@@ -1731,6 +2100,51 @@ Method Details
"tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
},
"preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
"adapterSize": "A String", # Optional. Adapter size for preference optimization.
"beta": 3.14, # Optional. Weight for KL Divergence regularization.
@@ -1746,6 +2160,51 @@ Method Details
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
@@ -1774,6 +2233,12 @@ Method Details
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -1878,6 +2343,12 @@ Method Details
},
},
"preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example.
"buckets": [ # Output only. Defines the histogram bucket.
{ # Dataset bucket used to create a histogram for the distribution given a population of values.
@@ -2166,6 +2637,7 @@ Method Details
},
},
},
+ "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running).
"updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
"veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning.
"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo.
@@ -2363,6 +2835,21 @@ Method Details
],
"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.
},
+ "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job.
+ { # Evaluate Dataset Run Result for Tuning Job.
+ "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
+ "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). # Output only. The error of the evaluation run if any.
+ "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.
+ },
+ "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.
+ },
+ ],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
@@ -2383,6 +2870,51 @@ Method Details
"tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
},
"preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
"adapterSize": "A String", # Optional. Adapter size for preference optimization.
"beta": 3.14, # Optional. Weight for KL Divergence regularization.
@@ -2398,6 +2930,51 @@ Method Details
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+ "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
+ "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
+ "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+ "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+ },
+ "metrics": [ # Required. The metrics used for evaluation.
+ { # The metric used for running evaluations.
+ "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+ "A String",
+ ],
+ "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+ "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+ },
+ "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+ },
+ "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+ "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+ "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+ },
+ "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+ "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+ "returnRawOutput": True or False, # Optional. Whether to return raw output.
+ },
+ "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+ "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+ },
+ "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+ "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+ "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+ "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+ },
+ },
+ ],
+ "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
+ "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
+ "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+ },
+ },
+ },
"exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
@@ -2426,6 +3003,12 @@ Method Details
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -2530,6 +3113,12 @@ Method Details
},
},
"preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization.
+ "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+ "A String",
+ ],
+ "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+ "A String",
+ ],
"scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example.
"buckets": [ # Output only. Defines the histogram bucket.
{ # Dataset bucket used to create a histogram for the distribution given a population of values.
@@ -2818,6 +3407,7 @@ Method Details
},
},
},
+ "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running).
"updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
"veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning.
"hyperParameters": { # Hyperparameters for Veo. # Optional. Hyperparameters for Veo.
diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html
index 7fa5452c61b..057d2013857 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -839,6 +839,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -1245,6 +1249,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -2821,6 +2826,10 @@ Method Details
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
+ "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
+ "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
@@ -3227,6 +3236,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html
index 2c9db24fedd..ddd9104f310 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html
@@ -152,12 +152,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -286,12 +302,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -361,12 +393,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
@@ -441,12 +489,28 @@ Method Details
},
],
"deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+ "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
"env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
+ "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+ "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+ { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+ "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+ "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+ "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+ },
+ ],
+ "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
+ "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+ "a_key": "A String",
+ },
"secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
{ # Represents an environment variable where the value is a secret in Cloud Secret Manager.
"name": "A String", # Required. Name of the secret environment variable.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
index aed32ddeb89..59df77bf382 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html
@@ -120,11 +120,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}
@@ -320,11 +322,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}
@@ -352,11 +356,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
},
],
@@ -391,11 +397,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
}
@@ -469,11 +477,13 @@ Method Details
"createTime": "A String", # Output only. Timestamp when this Memory was created.
"description": "A String", # Optional. Description of the Memory.
"displayName": "A String", # Optional. Display name of the Memory.
+ "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
"fact": "A String", # Required. Semantic knowledge extracted from the source content.
"name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
"scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
"a_key": "A String",
},
+ "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
},
},
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html
index 9460b2ca247..1acecf1a02d 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html
@@ -207,6 +207,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
index 36a852b6185..f166cff0607 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
@@ -211,6 +211,7 @@ Method Details
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
+ "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
index e124798438e..afee63b665d 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
@@ -20286,7 +20286,7 @@
}
}
},
-"revision": "20250731",
+"revision": "20250806",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -22338,6 +22338,7 @@
"PROHIBITED_CONTENT",
"SPII",
"MALFORMED_FUNCTION_CALL",
+"MODEL_ARMOR",
"IMAGE_SAFETY",
"IMAGE_PROHIBITED_CONTENT",
"IMAGE_RECITATION",
@@ -22355,6 +22356,7 @@
"Token generation stopped for potentially containing prohibited content.",
"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
"The function call generated by the model is invalid.",
+"The model response was blocked by Model Armor.",
"Token generation stopped because generated images has safety violations.",
"Image generation stopped because generated images has other prohibited content.",
"Image generation stopped due to recitation.",
@@ -24463,13 +24465,22 @@
"description": "The endpoint config to use for the deployment.",
"id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig",
"properties": {
+"dedicatedEndpointDisabled": {
+"description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.",
+"type": "boolean"
+},
"dedicatedEndpointEnabled": {
-"description": "Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.",
+"deprecated": true,
+"description": "Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.",
"type": "boolean"
},
"endpointDisplayName": {
"description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.",
"type": "string"
+},
+"endpointUserId": {
+"description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
+"type": "string"
}
},
"type": "object"
@@ -28633,6 +28644,10 @@
"description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
"type": "object"
},
+"modelArmorConfig": {
+"$ref": "GoogleCloudAiplatformV1ModelArmorConfig",
+"description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied."
+},
"safetySettings": {
"description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
"items": {
@@ -28710,6 +28725,7 @@
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT",
+"MODEL_ARMOR",
"IMAGE_SAFETY"
],
"enumDescriptions": [
@@ -28718,6 +28734,7 @@
"Candidates blocked due to other reason.",
"Candidates blocked due to the terms which are included from the terminology blocklist.",
"Candidates blocked due to prohibited content.",
+"The user prompt was blocked by Model Armor.",
"Candidates blocked due to unsafe image generation content."
],
"readOnly": true,
@@ -29358,6 +29375,11 @@
"description": "Chunk from context retrieved by the retrieval tools.",
"id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
"properties": {
+"documentName": {
+"description": "Output only. The full document name for the referenced Vertex AI Search document.",
+"readOnly": true,
+"type": "string"
+},
"ragChunk": {
"$ref": "GoogleCloudAiplatformV1RagChunk",
"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
@@ -32361,6 +32383,21 @@ false
},
"type": "object"
},
+"GoogleCloudAiplatformV1ModelArmorConfig": {
+"description": "Configuration for Model Armor integrations of prompt and responses.",
+"id": "GoogleCloudAiplatformV1ModelArmorConfig",
+"properties": {
+"promptTemplateName": {
+"description": "Optional. The name of the Model Armor template to use for prompt sanitization.",
+"type": "string"
+},
+"responseTemplateName": {
+"description": "Optional. The name of the Model Armor template to use for response sanitization.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1ModelBaseModelSource": {
"description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.",
"id": "GoogleCloudAiplatformV1ModelBaseModelSource",
@@ -38062,6 +38099,11 @@ false
"description": "The specification of a Reasoning Engine deployment.",
"id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec",
"properties": {
+"containerConcurrency": {
+"description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.",
+"format": "int32",
+"type": "integer"
+},
"env": {
"description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.",
"items": {
@@ -38069,6 +38111,27 @@ false
},
"type": "array"
},
+"maxInstances": {
+"description": "Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.",
+"format": "int32",
+"type": "integer"
+},
+"minInstances": {
+"description": "Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.",
+"format": "int32",
+"type": "integer"
+},
+"pscInterfaceConfig": {
+"$ref": "GoogleCloudAiplatformV1PscInterfaceConfig",
+"description": "Optional. Configuration for PSC-I."
+},
+"resourceLimits": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {\"cpu\": \"4\", \"memory\": \"4Gi\"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits",
+"type": "object"
+},
"secretEnv": {
"description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.",
"items": {
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
index 8b0ad6255ff..61152aee958 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
@@ -1446,6 +1446,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"recommendSpec": {
+"description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.recommendSpec",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}:recommendSpec",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"retrieveContexts": {
"description": "Retrieves relevant contexts for a query.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts",
@@ -25348,7 +25376,7 @@
}
}
},
-"revision": "20250731",
+"revision": "20250806",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -27589,6 +27617,7 @@
"PROHIBITED_CONTENT",
"SPII",
"MALFORMED_FUNCTION_CALL",
+"MODEL_ARMOR",
"IMAGE_SAFETY",
"IMAGE_PROHIBITED_CONTENT",
"IMAGE_RECITATION",
@@ -27606,6 +27635,7 @@
"Token generation stopped for potentially containing prohibited content.",
"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
"The function call generated by the model is invalid.",
+"The model response was blocked by Model Armor.",
"Token generation stopped because generated images has safety violations.",
"Image generation stopped because generated images has other prohibited content.",
"Image generation stopped due to recitation.",
@@ -29479,6 +29509,23 @@
"description": "Statistics computed over a tuning dataset.",
"id": "GoogleCloudAiplatformV1beta1DatasetStats",
"properties": {
+"droppedExampleIndices": {
+"description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"droppedExampleReasons": {
+"description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
"totalBillableCharacterCount": {
"description": "Output only. Number of billable characters in the tuning dataset.",
"format": "int64",
@@ -29969,13 +30016,22 @@
"description": "The endpoint config to use for the deployment.",
"id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig",
"properties": {
+"dedicatedEndpointDisabled": {
+"description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.",
+"type": "boolean"
+},
"dedicatedEndpointEnabled": {
-"description": "Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.",
+"deprecated": true,
+"description": "Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.",
"type": "boolean"
},
"endpointDisplayName": {
"description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.",
"type": "string"
+},
+"endpointUserId": {
+"description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
+"type": "string"
}
},
"type": "object"
@@ -30902,6 +30958,28 @@
},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1EvaluateDatasetRun": {
+"description": "Evaluate Dataset Run Result for Tuning Job.",
+"id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRun",
+"properties": {
+"checkpointId": {
+"description": "Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.",
+"readOnly": true,
+"type": "string"
+},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Output only. The error of the evaluation run if any.",
+"readOnly": true
+},
+"operationName": {
+"description": "Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1EvaluateInstancesRequest": {
"description": "Request message for EvaluationService.EvaluateInstances.",
"id": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest",
@@ -31255,6 +31333,28 @@
},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1EvaluationConfig": {
+"description": "Evaluation Config for Tuning Job.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationConfig",
+"properties": {
+"autoraterConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig",
+"description": "Optional. Autorater config for evaluation."
+},
+"metrics": {
+"description": "Required. The metrics used for evaluation.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Metric"
+},
+"type": "array"
+},
+"outputConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1OutputConfig",
+"description": "Required. Config for evaluation output."
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1EvaluationDataset": {
"description": "The dataset used for evaluation.",
"id": "GoogleCloudAiplatformV1beta1EvaluationDataset",
@@ -35194,6 +35294,10 @@
"description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
"type": "object"
},
+"modelArmorConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelArmorConfig",
+"description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied."
+},
"safetySettings": {
"description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
"items": {
@@ -35271,6 +35375,7 @@
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT",
+"MODEL_ARMOR",
"IMAGE_SAFETY"
],
"enumDescriptions": [
@@ -35279,6 +35384,7 @@
"Candidates blocked due to other reason.",
"Candidates blocked due to the terms which are included from the terminology blocklist.",
"Candidates blocked due to prohibited content.",
+"The user prompt was blocked by Model Armor.",
"Candidates blocked due to unsafe image generation content."
],
"readOnly": true,
@@ -36047,6 +36153,11 @@
"description": "Chunk from context retrieved by the retrieval tools.",
"id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext",
"properties": {
+"documentName": {
+"description": "Output only. The full document name for the referenced Vertex AI Search document.",
+"readOnly": true,
+"type": "string"
+},
"ragChunk": {
"$ref": "GoogleCloudAiplatformV1beta1RagChunk",
"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
@@ -38728,6 +38839,11 @@ false
"description": "Optional. Display name of the Memory.",
"type": "string"
},
+"expireTime": {
+"description": "Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.",
+"format": "google-datetime",
+"type": "string"
+},
"fact": {
"description": "Required. Semantic knowledge extracted from the source content.",
"type": "string"
@@ -38743,6 +38859,11 @@ false
"description": "Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.",
"type": "object"
},
+"ttl": {
+"description": "Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.",
+"format": "google-duration",
+"type": "string"
+},
"updateTime": {
"description": "Output only. Timestamp when this Memory was most recently updated.",
"format": "google-datetime",
@@ -39487,6 +39608,21 @@ false
},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1ModelArmorConfig": {
+"description": "Configuration for Model Armor integrations of prompt and responses.",
+"id": "GoogleCloudAiplatformV1beta1ModelArmorConfig",
+"properties": {
+"promptTemplateName": {
+"description": "Optional. The name of the Model Armor template to use for prompt sanitization.",
+"type": "string"
+},
+"responseTemplateName": {
+"description": "Optional. The name of the Model Armor template to use for response sanitization.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1ModelBaseModelSource": {
"description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.",
"id": "GoogleCloudAiplatformV1beta1ModelBaseModelSource",
@@ -44087,6 +44223,23 @@ false
"description": "Statistics computed for datasets used for preference optimization.",
"id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats",
"properties": {
+"droppedExampleIndices": {
+"description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"droppedExampleReasons": {
+"description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
"scoreVariancePerExampleDistribution": {
"$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution",
"description": "Output only. Dataset distributions for scores variance per example.",
@@ -44184,6 +44337,10 @@ false
"description": "Tuning Spec for Preference Optimization.",
"id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec",
"properties": {
+"evaluationConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig",
+"description": "Optional. Evaluation Config for Preference Optimization Job."
+},
"hyperParameters": {
"$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters",
"description": "Optional. Hyperparameters for Preference Optimization."
@@ -45604,7 +45761,7 @@ false
"description": "Optional. Immutable. The embedding model config of the RagCorpus."
},
"ragFilesCount": {
-"description": "Output only. Number of RagFiles in the RagCorpus.",
+"description": "Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.",
"format": "int32",
"readOnly": true,
"type": "integer"
@@ -46743,6 +46900,11 @@ false
"description": "The specification of a Reasoning Engine deployment.",
"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec",
"properties": {
+"containerConcurrency": {
+"description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.",
+"format": "int32",
+"type": "integer"
+},
"env": {
"description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.",
"items": {
@@ -46750,6 +46912,27 @@ false
},
"type": "array"
},
+"maxInstances": {
+"description": "Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.",
+"format": "int32",
+"type": "integer"
+},
+"minInstances": {
+"description": "Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.",
+"format": "int32",
+"type": "integer"
+},
+"pscInterfaceConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig",
+"description": "Optional. Configuration for PSC-I."
+},
+"resourceLimits": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {\"cpu\": \"4\", \"memory\": \"4Gi\"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits",
+"type": "object"
+},
"secretEnv": {
"description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.",
"items": {
@@ -46827,6 +47010,101 @@ false
"properties": {},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1RecommendSpecRequest": {
+"description": "Request message for ModelService.RecommendSpec.",
+"id": "GoogleCloudAiplatformV1beta1RecommendSpecRequest",
+"properties": {
+"checkMachineAvailability": {
+"description": "Optional. If true, check machine availability for the recommended regions. Only return the machine spec in regions where the machine is available.",
+"type": "boolean"
+},
+"checkUserQuota": {
+"description": "Optional. If true, check user quota for the recommended regions. Returns all the machine spec in regions they are available, and also the user quota state for each machine type in each region.",
+"type": "boolean"
+},
+"gcsUri": {
+"description": "Required. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model).",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1RecommendSpecResponse": {
+"description": "Response message for ModelService.RecommendSpec.",
+"id": "GoogleCloudAiplatformV1beta1RecommendSpecResponse",
+"properties": {
+"baseModel": {
+"description": "Output only. The base model used to finetune the custom model.",
+"readOnly": true,
+"type": "string"
+},
+"recommendations": {
+"description": "Output only. Recommendations of deployment options for the given custom weights model.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation"
+},
+"readOnly": true,
+"type": "array"
+},
+"specs": {
+"description": "Output only. The machine and model container specs.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec": {
+"description": "A machine and model container spec.",
+"id": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec",
+"properties": {
+"containerSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec",
+"description": "Output only. The model container spec.",
+"readOnly": true
+},
+"machineSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1MachineSpec",
+"description": "Output only. The machine spec.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation": {
+"description": "Recommendation of one deployment option for the given custom weights model in one region. Contains the machine and container spec, and user accelerator quota state.",
+"id": "GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation",
+"properties": {
+"region": {
+"description": "The region for the deployment spec (machine).",
+"type": "string"
+},
+"spec": {
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec",
+"description": "Output only. The machine and model container specs.",
+"readOnly": true
+},
+"userQuotaState": {
+"description": "Output only. The user accelerator quota state.",
+"enum": [
+"QUOTA_STATE_UNSPECIFIED",
+"QUOTA_STATE_USER_HAS_QUOTA",
+"QUOTA_STATE_NO_USER_QUOTA"
+],
+"enumDescriptions": [
+"Unspecified quota state. Quota information not available.",
+"User has enough accelerator quota for the machine type.",
+"User does not have enough accelerator quota for the machine type."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": {
"description": "Request message for MetadataService.DeleteContextChildrenRequest.",
"id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest",
@@ -54712,6 +54990,10 @@ false
"description": "Tuning Spec for Supervised Tuning for first party models.",
"id": "GoogleCloudAiplatformV1beta1SupervisedTuningSpec",
"properties": {
+"evaluationConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig",
+"description": "Optional. Evaluation Config for Tuning Job."
+},
"exportLastCheckpointOnly": {
"description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.",
"type": "boolean"
@@ -56563,6 +56845,14 @@ false
"description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.",
"readOnly": true
},
+"evaluateDatasetRuns": {
+"description": "Output only. Evaluation runs for the Tuning Job.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRun"
+},
+"readOnly": true,
+"type": "array"
+},
"experiment": {
"description": "Output only. The Experiment associated with this TuningJob.",
"readOnly": true,
@@ -56673,6 +56963,27 @@ false
"description": "Output only. The tuning data statistics associated with this TuningJob.",
"readOnly": true
},
+"tuningJobState": {
+"description": "Output only. The detail state of the tuning job (while the overall `JobState` is running).",
+"enum": [
+"TUNING_JOB_STATE_UNSPECIFIED",
+"TUNING_JOB_STATE_WAITING_FOR_QUOTA",
+"TUNING_JOB_STATE_PROCESSING_DATASET",
+"TUNING_JOB_STATE_WAITING_FOR_CAPACITY",
+"TUNING_JOB_STATE_TUNING",
+"TUNING_JOB_STATE_POST_PROCESSING"
+],
+"enumDescriptions": [
+"Default tuning job state.",
+"Tuning job is waiting for job quota.",
+"Tuning job is validating the dataset.",
+"Tuning job is waiting for hardware capacity.",
+"Tuning job is running.",
+"Tuning job is doing some post processing steps."
+],
+"readOnly": true,
+"type": "string"
+},
"updateTime": {
"description": "Output only. Time when the TuningJob was most recently updated.",
"format": "google-datetime",
From 4a2d6048b1dfb588990739aec87ed71fe6444167 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Instance Methods
Returns the listings Resource.
+
+ queryTemplates()
+
Returns the queryTemplates Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html new file mode 100644 index 00000000000..3da77bc490e --- /dev/null +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html @@ -0,0 +1,387 @@ + + + +
+ approve(name, body=None, x__xgafv=None)
Approves a query template.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, queryTemplateId=None, x__xgafv=None)
Creates a new QueryTemplate
+ +Deletes a query template.
+ +Gets a QueryTemplate
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all QueryTemplates in a given project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing QueryTemplate
+
+ submit(name, body=None, x__xgafv=None)
Submits a query template for approval.
+approve(name, body=None, x__xgafv=None)
+ Approves a query template.
+
+Args:
+ name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message for approving a QueryTemplate.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, queryTemplateId=None, x__xgafv=None)
+ Creates a new QueryTemplate
+
+Args:
+ parent: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myQueryTemplate`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+
+ queryTemplateId: string, Required. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+delete(name, x__xgafv=None)
+ Deletes a query template.
+
+Args:
+ name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (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 a QueryTemplate
+
+Args:
+ name: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all QueryTemplates in a given project and location.
+
+Args:
+ parent: string, Required. The parent resource path of the QueryTemplates. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
+ pageSize: integer, Optional. The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
+ pageToken: string, Optional. Page token, returned by a previous call, to request the next page of results.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to the list of QueryTemplates.
+ "nextPageToken": "A String", # A token to request the next page of results.
+ "queryTemplates": [ # The list of QueryTemplates.
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+ },
+ ],
+}
+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)
+ Updates an existing QueryTemplate
+
+Args:
+ name: string, Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+
+ updateMask: string, Optional. Field mask specifies the fields to update in the query template resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+submit(name, body=None, x__xgafv=None)
+ Submits a query template for approval.
+
+Args:
+ name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message for submitting a QueryTemplate.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
+ "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
+ "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+ "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+ "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
+ "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
+ "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
+ "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
+ "definitionBody": "A String", # Optional. The definition body of the routine.
+ "routineType": "A String", # Required. The type of routine.
+ },
+ "state": "A String", # Output only. The QueryTemplate lifecycle state.
+ "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
+}
+Returns the groups Resource.
+ +Returns the inboundOidcSsoProfiles Resource.
+ diff --git a/docs/dyn/cloudidentity_v1.inboundOidcSsoProfiles.html b/docs/dyn/cloudidentity_v1.inboundOidcSsoProfiles.html new file mode 100644 index 00000000000..89889e8bd1b --- /dev/null +++ b/docs/dyn/cloudidentity_v1.inboundOidcSsoProfiles.html @@ -0,0 +1,334 @@ + + + +
+ close()
Close httplib2 connections.
+
+ create(body=None, x__xgafv=None)
Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+ +Deletes an InboundOidcSsoProfile.
+ +Gets an InboundOidcSsoProfile.
+
+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists InboundOidcSsoProfile objects for a Google enterprise customer.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+close()
+ Close httplib2 connections.+
create(body=None, x__xgafv=None)
+ Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes an InboundOidcSsoProfile.
+
+Args:
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to delete. Format: `inboundOidcSsoProfiles/{sso_profile_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Gets an InboundOidcSsoProfile.
+
+Args:
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to get. Format: `inboundOidcSsoProfiles/{sso_profile_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists InboundOidcSsoProfile objects for a Google enterprise customer.
+
+Args:
+ filter: string, A [Common Expression Language](https://github.com/google/cel-spec) expression to filter the results. The only supported filter is filtering by customer. For example: `customer=="customers/C0123abc"`. Omitting the filter or specifying a filter of `customer=="customers/my_customer"` will return the profiles for the customer that the caller (authenticated user) belongs to. Specifying a filter of `customer==""` will return the global shared OIDC profiles.
+ pageSize: integer, The maximum number of InboundOidcSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.
+ pageToken: string, A page token, received from a previous `ListInboundOidcSsoProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundOidcSsoProfiles` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response of the InboundOidcSsoProfilesService.ListInboundOidcSsoProfiles method.
+ "inboundOidcSsoProfiles": [ # List of InboundOidcSsoProfiles.
+ { # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "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.
+}
+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)
+ Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+
+Args:
+ name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+
+ updateMask: string, Required. The list of fields to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+Returns the groups Resource.
+ +Returns the inboundOidcSsoProfiles Resource.
+ diff --git a/docs/dyn/cloudidentity_v1beta1.inboundOidcSsoProfiles.html b/docs/dyn/cloudidentity_v1beta1.inboundOidcSsoProfiles.html new file mode 100644 index 00000000000..f6543194f89 --- /dev/null +++ b/docs/dyn/cloudidentity_v1beta1.inboundOidcSsoProfiles.html @@ -0,0 +1,334 @@ + + + +
+ close()
Close httplib2 connections.
+
+ create(body=None, x__xgafv=None)
Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+ +Deletes an InboundOidcSsoProfile.
+ +Gets an InboundOidcSsoProfile.
+
+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists InboundOidcSsoProfile objects for a Google enterprise customer.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+close()
+ Close httplib2 connections.+
create(body=None, x__xgafv=None)
+ Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes an InboundOidcSsoProfile.
+
+Args:
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to delete. Format: `inboundOidcSsoProfiles/{sso_profile_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Gets an InboundOidcSsoProfile.
+
+Args:
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to get. Format: `inboundOidcSsoProfiles/{sso_profile_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists InboundOidcSsoProfile objects for a Google enterprise customer.
+
+Args:
+ filter: string, A [Common Expression Language](https://github.com/google/cel-spec) expression to filter the results. The only supported filter is filtering by customer. For example: `customer=="customers/C0123abc"`. Omitting the filter or specifying a filter of `customer=="customers/my_customer"` will return the profiles for the customer that the caller (authenticated user) belongs to. Specifying a filter of `customer==""` will return the global shared OIDC profiles.
+ pageSize: integer, The maximum number of InboundOidcSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.
+ pageToken: string, A page token, received from a previous `ListInboundOidcSsoProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundOidcSsoProfiles` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response of the InboundOidcSsoProfilesService.ListInboundOidcSsoProfiles method.
+ "inboundOidcSsoProfiles": [ # List of InboundOidcSsoProfiles.
+ { # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "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.
+}
+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)
+ Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `"done": false`, it will not have a response, and the metadata will have `"state": "awaiting-multi-party-approval"`.
+
+Args:
+ name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.
+ "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
+ "displayName": "A String", # Human-readable name of the OIDC SSO profile.
+ "idpConfig": { # OIDC IDP (identity provider) configuration. # OIDC identity provider configuration.
+ "changePasswordUri": "A String", # The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.
+ "issuerUri": "A String", # Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).
+ },
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.
+ "rpConfig": { # OIDC RP (relying party) configuration. # OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
+ "clientId": "A String", # OAuth2 client ID for OIDC.
+ "clientSecret": "A String", # Input only. OAuth2 client secret for OIDC.
+ "redirectUris": [ # Output only. The URL(s) that this client may use in authentication requests.
+ "A String",
+ ],
+ },
+}
+
+ updateMask: string, Required. The list of fields to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
create(parent, body=None, x__xgafv=None)
Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.
+
+ decapsulate(name, body=None, x__xgafv=None)
Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.
destroy(name, body=None, x__xgafv=None)
Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
@@ -286,6 +289,37 @@decapsulate(name, body=None, x__xgafv=None)
+ Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.
+
+Args:
+ name: string, Required. The resource name of the CryptoKeyVersion to use for decapsulation. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for KeyManagementService.Decapsulate.
+ "ciphertext": "A String", # Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
+ "ciphertextCrc32c": "A String", # Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
+}
+
+ 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 KeyManagementService.Decapsulate.
+ "name": "A String", # The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
+ "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
+ "sharedSecret": "A String", # The decapsulated shared_secret originally encapsulated with the matching public key.
+ "sharedSecretCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
+ "verifiedCiphertextCrc32c": True or False, # Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
+}
+destroy(name, body=None, x__xgafv=None)
Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process. @@ -404,7 +438,9 @@Method Details
Allowed values PUBLIC_KEY_FORMAT_UNSPECIFIED - If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format. PEM - The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information. + DER - The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208). NIST_PQC - This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205). + XWING_RAW_BYTES - The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index a643b96151b..9c738d9dd5e 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -1795,6 +1795,35 @@ "https://www.googleapis.com/auth/cloudkms" ] }, +"decapsulate": { +"description": "Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:decapsulate", +"httpMethod": "POST", +"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.decapsulate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the CryptoKeyVersion to use for decapsulation.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:decapsulate", +"request": { +"$ref": "DecapsulateRequest" +}, +"response": { +"$ref": "DecapsulateResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudkms" +] +}, "destroy": { "description": "Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy", @@ -1871,12 +1900,16 @@ "enum": [ "PUBLIC_KEY_FORMAT_UNSPECIFIED", "PEM", -"NIST_PQC" +"DER", +"NIST_PQC", +"XWING_RAW_BYTES" ], "enumDescriptions": [ "If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", "The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", -"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." +"The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).", +"The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem." ], "location": "query", "type": "string" @@ -2402,7 +2435,7 @@ } } }, -"revision": "20250523", +"revision": "20250731", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2799,7 +2832,8 @@ "ASYMMETRIC_SIGN", "ASYMMETRIC_DECRYPT", "RAW_ENCRYPT_DECRYPT", -"MAC" +"MAC", +"KEY_ENCAPSULATION" ], "enumDescriptions": [ "Not specified.", @@ -2807,7 +2841,8 @@ "CryptoKeys with this purpose may be used with AsymmetricSign and GetPublicKey.", "CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey.", "CryptoKeys with this purpose may be used with RawEncrypt and RawDecrypt. This purpose is meant to be used for interoperable symmetric encryption and does not support automatic CryptoKey rotation.", -"CryptoKeys with this purpose may be used with MacSign." +"CryptoKeys with this purpose may be used with MacSign.", +"CryptoKeys with this purpose may be used with GetPublicKey and Decapsulate." ], "type": "string" }, @@ -2866,6 +2901,9 @@ "HMAC_SHA512", "HMAC_SHA224", "EXTERNAL_SYMMETRIC_ENCRYPTION", +"ML_KEM_768", +"ML_KEM_1024", +"KEM_XWING", "PQ_SIGN_ML_DSA_65", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" @@ -2907,6 +2945,9 @@ "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", "Algorithm representing symmetric encryption by an external key manager.", +"ML-KEM-768 (FIPS 203)", +"ML-KEM-1024 (FIPS 203)", +"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." @@ -3078,6 +3119,9 @@ "HMAC_SHA512", "HMAC_SHA224", "EXTERNAL_SYMMETRIC_ENCRYPTION", +"ML_KEM_768", +"ML_KEM_1024", +"KEM_XWING", "PQ_SIGN_ML_DSA_65", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" @@ -3119,6 +3163,9 @@ "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", "Algorithm representing symmetric encryption by an external key manager.", +"ML-KEM-768 (FIPS 203)", +"ML-KEM-1024 (FIPS 203)", +"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." @@ -3146,6 +3193,66 @@ }, "type": "object" }, +"DecapsulateRequest": { +"description": "Request message for KeyManagementService.Decapsulate.", +"id": "DecapsulateRequest", +"properties": { +"ciphertext": { +"description": "Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).", +"format": "byte", +"type": "string" +}, +"ciphertextCrc32c": { +"description": "Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DecapsulateResponse": { +"description": "Response message for KeyManagementService.Decapsulate.", +"id": "DecapsulateResponse", +"properties": { +"name": { +"description": "The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.", +"type": "string" +}, +"protectionLevel": { +"description": "The ProtectionLevel of the CryptoKeyVersion used in decapsulation.", +"enum": [ +"PROTECTION_LEVEL_UNSPECIFIED", +"SOFTWARE", +"HSM", +"EXTERNAL", +"EXTERNAL_VPC" +], +"enumDescriptions": [ +"Not specified.", +"Crypto operations are performed in software.", +"Crypto operations are performed in a Hardware Security Module.", +"Crypto operations are performed by an external key manager.", +"Crypto operations are performed in an EKM-over-VPC backend." +], +"type": "string" +}, +"sharedSecret": { +"description": "The decapsulated shared_secret originally encapsulated with the matching public key.", +"format": "byte", +"type": "string" +}, +"sharedSecretCrc32c": { +"description": "Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.", +"format": "int64", +"type": "string" +}, +"verifiedCiphertextCrc32c": { +"description": "Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.", +"type": "boolean" +} +}, +"type": "object" +}, "DecryptRequest": { "description": "Request message for KeyManagementService.Decrypt.", "id": "DecryptRequest", @@ -3505,6 +3612,9 @@ "HMAC_SHA512", "HMAC_SHA224", "EXTERNAL_SYMMETRIC_ENCRYPTION", +"ML_KEM_768", +"ML_KEM_1024", +"KEM_XWING", "PQ_SIGN_ML_DSA_65", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" @@ -3546,6 +3656,9 @@ "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", "Algorithm representing symmetric encryption by an external key manager.", +"ML-KEM-768 (FIPS 203)", +"ML-KEM-1024 (FIPS 203)", +"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." @@ -4260,6 +4373,9 @@ "HMAC_SHA512", "HMAC_SHA224", "EXTERNAL_SYMMETRIC_ENCRYPTION", +"ML_KEM_768", +"ML_KEM_1024", +"KEM_XWING", "PQ_SIGN_ML_DSA_65", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" @@ -4301,6 +4417,9 @@ "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", "Algorithm representing symmetric encryption by an external key manager.", +"ML-KEM-768 (FIPS 203)", +"ML-KEM-1024 (FIPS 203)", +"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." @@ -4347,12 +4466,16 @@ "enum": [ "PUBLIC_KEY_FORMAT_UNSPECIFIED", "PEM", -"NIST_PQC" +"DER", +"NIST_PQC", +"XWING_RAW_BYTES" ], "enumDescriptions": [ "If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", "The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", -"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." +"The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).", +"The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem." ], "type": "string" } From 38c4209338d9e81a75fd2254a5869fd4d024234e Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 12 Aug 2025 07:09:58 +0000 Subject: [PATCH 13/32] feat(cloudsupport): update the api #### cloudsupport:v2beta The following keys were added: - resources.cases.resources.attachments.methods.get (Total Keys: 11) - resources.cases.resources.comments.methods.get (Total Keys: 11) --- ...cloudsupport_v2beta.cases.attachments.html | 32 ++++++++++++ .../cloudsupport_v2beta.cases.comments.html | 31 +++++++++++ .../documents/cloudsupport.v2beta.json | 52 ++++++++++++++++++- 3 files changed, 114 insertions(+), 1 deletion(-) diff --git a/docs/dyn/cloudsupport_v2beta.cases.attachments.html b/docs/dyn/cloudsupport_v2beta.cases.attachments.html index c75a4e933a1..336e9f6b016 100644 --- a/docs/dyn/cloudsupport_v2beta.cases.attachments.html +++ b/docs/dyn/cloudsupport_v2beta.cases.attachments.html @@ -77,6 +77,9 @@ Instance Methods
Close httplib2 connections.
+ +Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
@@ -89,6 +92,35 @@Method Details
Close httplib2 connections.
get(name, x__xgafv=None)
+ Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+
+Args:
+ name: string, Required. The name of the attachment to get. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a "case" level, not a "comment" level.
+ "createTime": "A String", # Output only. The time at which the attachment was created.
+ "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
+ "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+ "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+ "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+ "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+ },
+ "filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
+ "mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
+ "name": "A String", # Output only. Identifier. The resource name of the attachment.
+ "sizeBytes": "A String", # Output only. The size of the attachment in bytes.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/docs/dyn/cloudsupport_v2beta.cases.comments.html b/docs/dyn/cloudsupport_v2beta.cases.comments.html
index 0c80605f0df..69eb6b78a08 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.comments.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.comments.html
@@ -80,6 +80,9 @@ Instance Methods
create(parent, body=None, x__xgafv=None)
Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
+
+Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
@@ -136,6 +139,34 @@ Method Details
}
get(name, x__xgafv=None)
+ Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+
+Args:
+ name: string, Required. The name of the comment to retrieve. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.
+ "body": "A String", # The full comment body. Maximum of 12800 characters.
+ "createTime": "A String", # Output only. The time when the comment was created.
+ "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
+ "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+ "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+ "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+ "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the comment.
+ "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
index 8fef4e5d4e0..cbaf5e64ea5 100644
--- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
@@ -439,6 +439,31 @@
"resources": {
"attachments": {
"methods": {
+"get": {
+"description": "Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment=\"projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$attachment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .get(name=\"projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB\") ) print(request.execute()) ```",
+"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}",
+"httpMethod": "GET",
+"id": "cloudsupport.cases.attachments.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the attachment to get.",
+"location": "path",
+"pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+name}",
+"response": {
+"$ref": "Attachment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"list": {
"description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments",
@@ -507,6 +532,31 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"get": {
+"description": "Retrieve a comment. EXAMPLES: cURL: ```shell comment=\"projects/some-project/cases/43595344/comments/234567890\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$comment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().comments().get( name=\"projects/some-project/cases/43595344/comments/234567890\", ) print(request.execute()) ```",
+"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments/{commentsId}",
+"httpMethod": "GET",
+"id": "cloudsupport.cases.comments.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the comment to retrieve.",
+"location": "path",
+"pattern": "^[^/]+/[^/]+/cases/[^/]+/comments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+name}",
+"response": {
+"$ref": "Comment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"list": {
"description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments",
@@ -619,7 +669,7 @@
}
}
},
-"revision": "20250609",
+"revision": "20250806",
"rootUrl": "https://cloudsupport.googleapis.com/",
"schemas": {
"Actor": {
From 34f2f0cea03bac9f172300dcc25ae64274560a8c Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 12 Aug 2025 07:09:59 +0000
Subject: [PATCH 14/32] feat(compute): update the api
#### compute:alpha
The following keys were added:
- resources.haControllers.methods.delete (Total Keys: 20)
- resources.haControllers.methods.get (Total Keys: 19)
- resources.haControllers.methods.insert (Total Keys: 18)
- resources.haControllers.methods.list (Total Keys: 28)
- resources.haControllers.methods.patch (Total Keys: 25)
- resources.regionHealthAggregationPolicies.methods.aggregatedList (Total Keys: 29)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 22)
- schemas.AllocationAggregateReservation.properties.hostCount (Total Keys: 2)
- schemas.AllocationAggregateReservation.properties.inUseHostCount (Total Keys: 2)
- schemas.AllocationAggregateReservation.properties.inUseInstanceCount (Total Keys: 2)
- schemas.Backend.properties.maxInFlightRequests (Total Keys: 6)
- schemas.Backend.properties.trafficDuration.type (Total Keys: 1)
- schemas.ExternalVpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.ExternalVpnGatewayParams (Total Keys: 4)
- schemas.FutureReservation.properties.protectionTier.type (Total Keys: 1)
- schemas.HaController (Total Keys: 104)
- schemas.HealthAggregationPoliciesScopedList (Total Keys: 11)
- schemas.HealthAggregationPolicyAggregatedList (Total Keys: 18)
- schemas.MultiMigStatus.properties.appliedAcceleratorTopologies (Total Keys: 2)
- schemas.MultiMigStatusAcceleratorTopology (Total Keys: 21)
- schemas.NetworkProfileNetworkFeatures.properties.allowFirewallPolicy.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowVpcFirewallRules.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.firewallPolicyTypes (Total Keys: 2)
- schemas.ReservationBlock.properties.inUseHostCount (Total Keys: 2)
- schemas.ReservationSubBlock.properties.inUseHostCount (Total Keys: 2)
- schemas.ReservationSubBlocksReportFaultyRequest (Total Keys: 9)
- schemas.ResourceStatus.properties.consumedReservation.deprecated (Total Keys: 1)
- schemas.ResourceStatus.properties.consumedReservationBlock.deprecated (Total Keys: 1)
- schemas.TargetVpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.TargetVpnGatewayParams (Total Keys: 4)
- schemas.VpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.VpnGatewayParams (Total Keys: 4)
- schemas.VpnTunnel.properties.params.$ref (Total Keys: 1)
- schemas.VpnTunnelParams (Total Keys: 4)
#### compute:beta
The following keys were added:
- schemas.Backend.properties.maxInFlightRequests (Total Keys: 6)
- schemas.Backend.properties.trafficDuration.type (Total Keys: 1)
- schemas.ManagedInstance.properties.scheduling.$ref (Total Keys: 1)
- schemas.ManagedInstanceScheduling (Total Keys: 4)
- schemas.Reservation.properties.advancedDeploymentControl.$ref (Total Keys: 1)
- schemas.ReservationAdvancedDeploymentControl (Total Keys: 3)
#### compute:v1
The following keys were added:
- resources.networks.methods.requestRemovePeering (Total Keys: 18)
- schemas.BackendBucket.properties.params.$ref (Total Keys: 1)
- schemas.BackendBucketParams (Total Keys: 4)
- schemas.BackendService.properties.params.$ref (Total Keys: 1)
- schemas.BackendServiceParams (Total Keys: 4)
- schemas.Interconnect.properties.aaiEnabled.type (Total Keys: 1)
- schemas.Interconnect.properties.applicationAwareInterconnect.$ref (Total Keys: 1)
- schemas.InterconnectApplicationAwareInterconnect (Total Keys: 17)
- schemas.NetworkPeering.properties.connectionStatus.$ref (Total Keys: 1)
- schemas.NetworkPeering.properties.updateStrategy.type (Total Keys: 1)
- schemas.NetworkPeeringConnectionStatus (Total Keys: 16)
- schemas.NetworksRequestRemovePeeringRequest (Total Keys: 3)
- schemas.Reservation.properties.advancedDeploymentControl.$ref (Total Keys: 1)
- schemas.ReservationAdvancedDeploymentControl (Total Keys: 3)
---
docs/dyn/compute_alpha.advice.html | 2 +-
docs/dyn/compute_alpha.backendServices.html | 28 +
.../compute_alpha.externalVpnGateways.html | 15 +
.../dyn/compute_alpha.futureReservations.html | 20 +
docs/dyn/compute_alpha.haControllers.html | 1035 ++++++++
docs/dyn/compute_alpha.networkProfiles.html | 10 +
.../compute_alpha.regionBackendServices.html | 24 +
docs/dyn/compute_alpha.regionCommitments.html | 18 +
...alpha.regionHealthAggregationPolicies.html | 92 +
docs/dyn/compute_alpha.regionMultiMigs.html | 153 ++
docs/dyn/compute_alpha.reservationBlocks.html | 2 +
.../compute_alpha.reservationSubBlocks.html | 146 ++
docs/dyn/compute_alpha.reservations.html | 15 +
docs/dyn/compute_alpha.resourcePolicies.html | 40 +-
docs/dyn/compute_alpha.targetVpnGateways.html | 20 +
docs/dyn/compute_alpha.vpnGateways.html | 20 +
docs/dyn/compute_alpha.vpnTunnels.html | 20 +
docs/dyn/compute_beta.backendServices.html | 28 +
.../compute_beta.instanceGroupManagers.html | 3 +
.../compute_beta.regionBackendServices.html | 24 +
docs/dyn/compute_beta.regionCommitments.html | 18 +
...pute_beta.regionInstanceGroupManagers.html | 3 +
docs/dyn/compute_beta.reservations.html | 15 +
docs/dyn/compute_beta.resourcePolicies.html | 40 +-
docs/dyn/compute_v1.backendBuckets.html | 25 +
docs/dyn/compute_v1.backendServices.html | 35 +
docs/dyn/compute_v1.interconnects.html | 80 +
docs/dyn/compute_v1.networks.html | 224 ++
.../dyn/compute_v1.regionBackendServices.html | 30 +
docs/dyn/compute_v1.regionCommitments.html | 15 +
docs/dyn/compute_v1.reservations.html | 15 +
docs/dyn/compute_v1.resourcePolicies.html | 40 +-
.../documents/compute.alpha.json | 2100 ++++++++++++++---
.../documents/compute.beta.json | 82 +-
.../discovery_cache/documents/compute.v1.json | 328 ++-
35 files changed, 4422 insertions(+), 343 deletions(-)
diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html
index 1b89d4a8276..6d8020ceb8e 100644
--- a/docs/dyn/compute_alpha.advice.html
+++ b/docs/dyn/compute_alpha.advice.html
@@ -210,7 +210,7 @@ Method Details
An object of the form:
{ # A response contains multiple scoring recommendations.
- "recommendations": [ # Initially the API will provide one recommendation which balances the individual scores according to Google's preference.
+ "recommendations": [ # Initially the API will provide one recommendation which balances the individual scores according to service provider's preference.
{
"scores": { # The Scores message groups information about a shard of capacity.
"obtainability": 3.14, # The obtainability score indicates the likelihood of successfully obtaining (provisioning) the requested number of VMs. The score range is 0.0 through 1.0. Higher is better.
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
index ed0f51b85fc..20e04877146 100644
--- a/docs/dyn/compute_alpha.backendServices.html
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -317,11 +317,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -1120,11 +1124,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -2003,11 +2011,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -2630,11 +2642,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -3155,11 +3171,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -3696,11 +3716,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
@@ -4706,11 +4730,15 @@ Method Details
"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
+ "maxInFlightRequests": 42, # Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerEndpoint": 42, # Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION.
+ "maxInFlightRequestsPerInstance": 42, # Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION.
"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
"maxUtilization": 3.14, # Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
"preference": "A String", # This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
+ "trafficDuration": "A String",
},
],
"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
diff --git a/docs/dyn/compute_alpha.externalVpnGateways.html b/docs/dyn/compute_alpha.externalVpnGateways.html
index 20d892e9c59..fe9db18f900 100644
--- a/docs/dyn/compute_alpha.externalVpnGateways.html
+++ b/docs/dyn/compute_alpha.externalVpnGateways.html
@@ -261,6 +261,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+ "resourceManagerTags": { # Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+ "a_key": "A String",
+ },
+ },
"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
}
@@ -292,6 +297,11 @@ Close httplib2 connections.
+
+ delete(project, region, haController, requestId=None, x__xgafv=None)
Deletes an HaController in the specified project.
failover(project, region, haController, body=None, requestId=None, x__xgafv=None)
Fails over a VM targeted by the specified HaController to the selected zone.
+
+ get(project, region, haController, x__xgafv=None)
Returns all the details of a specific HaController.
+
+ insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates HaController in the specified project.
+ +Lists all HaControllers in the specified project in the specified region.
+ +Retrieves the next page of results.
+
+ patch(project, region, haController, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates HaController in the specified project.
close()
Close httplib2 connections.
delete(project, region, haController, requestId=None, x__xgafv=None)
+ Deletes an HaController in the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ haController: string, Name of the HaController resource to delete. (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.
+ 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, read Handling 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 in RFC3339 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.
+ },
+ ],
+ },
+ "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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # [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] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # [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 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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+ "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 in RFC3339 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.
+}
+failover(project, region, haController, body=None, requestId=None, x__xgafv=None)
Fails over a VM targeted by the specified HaController to the selected zone. @@ -219,4 +363,895 @@Method Details
}
get(project, region, haController, x__xgafv=None)
+ Returns all the details of a specific HaController.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ haController: string, Name of the HaController resource to return. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # HaController handles failover for a VM Instance.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "failoverInitiation": "A String", # Indicates how failover should be initiated.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "instanceName": "A String", # Name of the instance that HaController is in charge of. If not specified the HaController's resource name will be used instead. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "kind": "compute#HaController", # [Output Only] Type of the resource. Always compute#haController for HaControllers.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "secondaryZoneCapacity": "A String", # Indicates the capacity guarantees in the secondary zone.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+ "status": { # Contains information about current status of the HaController. # [Output Only] Status information for the HaController resource.
+ "failoverProgress": { # Contains information about the current failover operation. # [Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress.
+ "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or manually.
+ "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+ "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field is filled only if the current failover is failing
+ "errors": { # [Output Only] Encountered errors during the last attempt to process failover.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ "ongoingFailover": True or False, # [Output Only] Indicates if the failover is currently in-progress.
+ "primaryInstance": "A String", # [Output Only] The URL to the instance that is intended to be primary at this moment. Primary instance will be changed at the very beginning of a failover operation.
+ "primaryZone": "A String", # [Output Only] The name of the zone that is intended to be primary at this moment. Primary zone will be changed at the very beginning of a failover operation. The zone may not be operational in the middle of a failover operation.
+ "readyForFailover": True or False, # [Output Only] Indicates if the resource is ready for initiating a failover to the secondary zone.
+ "zoneStatus": { # [Output Only] Map of zone statuses. Key: name of the zone Value: ZoneStatus
+ "a_key": { # Contains the status of a specific zone.
+ "isPrimary": True or False, # [Output Only] Indicates if the zone is primary at this moment.
+ "isZoneReady": True or False, # [Output Only] Indicates if the zone is ready for initiating a failover.
+ "lastError": { # Contains details of the last failed operation. # [Output Only] This field is filled only if the current operation is failing.
+ "errors": { # [Output Only] Encountered errors.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ },
+ },
+ "zoneConfigurations": { # Map of zone configurations Key: name of the zone Value: ZoneConfiguration
+ "a_key": { # Config for a zone that the HaController may use for running the VM instance.
+ "nodeAffinities": [ # A set of node affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
+ { # Node Affinity: the configuration of desired nodes onto which the Instance could be scheduled. This message should be an exact copy of the Instances representation of NodeAffinity. LINT.IfChange(HaControllerNodeAffinityMixer)
+ "key": "A String", # Corresponds to the label key of Node resource.
+ "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
+ "values": [ # Corresponds to the label values of Node resource.
+ "A String",
+ ],
+ },
+ ],
+ "reservationAffinity": { # Specifies the reservations that this instance can consume from. This message should be an exact copy of the Instances representation of AllocationAffinity. LINT.IfChange(HaControllerAllocationAffinityMixer) # Specifies the reservations that the instance can consume from.
+ "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
+ "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
+ "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
+ "A String",
+ ],
+ },
+ },
+ },
+}
+insert(project, region, body=None, requestId=None, x__xgafv=None)
+ Creates HaController in the specified project.
+
+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:
+
+{ # HaController handles failover for a VM Instance.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "failoverInitiation": "A String", # Indicates how failover should be initiated.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "instanceName": "A String", # Name of the instance that HaController is in charge of. If not specified the HaController's resource name will be used instead. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "kind": "compute#HaController", # [Output Only] Type of the resource. Always compute#haController for HaControllers.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "secondaryZoneCapacity": "A String", # Indicates the capacity guarantees in the secondary zone.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+ "status": { # Contains information about current status of the HaController. # [Output Only] Status information for the HaController resource.
+ "failoverProgress": { # Contains information about the current failover operation. # [Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress.
+ "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or manually.
+ "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+ "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field is filled only if the current failover is failing
+ "errors": { # [Output Only] Encountered errors during the last attempt to process failover.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ "ongoingFailover": True or False, # [Output Only] Indicates if the failover is currently in-progress.
+ "primaryInstance": "A String", # [Output Only] The URL to the instance that is intended to be primary at this moment. Primary instance will be changed at the very beginning of a failover operation.
+ "primaryZone": "A String", # [Output Only] The name of the zone that is intended to be primary at this moment. Primary zone will be changed at the very beginning of a failover operation. The zone may not be operational in the middle of a failover operation.
+ "readyForFailover": True or False, # [Output Only] Indicates if the resource is ready for initiating a failover to the secondary zone.
+ "zoneStatus": { # [Output Only] Map of zone statuses. Key: name of the zone Value: ZoneStatus
+ "a_key": { # Contains the status of a specific zone.
+ "isPrimary": True or False, # [Output Only] Indicates if the zone is primary at this moment.
+ "isZoneReady": True or False, # [Output Only] Indicates if the zone is ready for initiating a failover.
+ "lastError": { # Contains details of the last failed operation. # [Output Only] This field is filled only if the current operation is failing.
+ "errors": { # [Output Only] Encountered errors.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ },
+ },
+ "zoneConfigurations": { # Map of zone configurations Key: name of the zone Value: ZoneConfiguration
+ "a_key": { # Config for a zone that the HaController may use for running the VM instance.
+ "nodeAffinities": [ # A set of node affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
+ { # Node Affinity: the configuration of desired nodes onto which the Instance could be scheduled. This message should be an exact copy of the Instances representation of NodeAffinity. LINT.IfChange(HaControllerNodeAffinityMixer)
+ "key": "A String", # Corresponds to the label key of Node resource.
+ "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
+ "values": [ # Corresponds to the label values of Node resource.
+ "A String",
+ ],
+ },
+ ],
+ "reservationAffinity": { # Specifies the reservations that this instance can consume from. This message should be an exact copy of the Instances representation of AllocationAffinity. LINT.IfChange(HaControllerAllocationAffinityMixer) # Specifies the reservations that the instance can consume from.
+ "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
+ "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
+ "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
+ "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, read Handling 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 in RFC3339 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.
+ },
+ ],
+ },
+ "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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # [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] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # [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 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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+ "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 in RFC3339 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, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists all HaControllers in the specified project in the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (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 on resource 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 Google RE2 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", # Unique identifier for the resource; defined by the server.
+ "items": [ # A list of HaControllers in the specified project and region.
+ { # HaController handles failover for a VM Instance.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "failoverInitiation": "A String", # Indicates how failover should be initiated.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "instanceName": "A String", # Name of the instance that HaController is in charge of. If not specified the HaController's resource name will be used instead. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "kind": "compute#HaController", # [Output Only] Type of the resource. Always compute#haController for HaControllers.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "secondaryZoneCapacity": "A String", # Indicates the capacity guarantees in the secondary zone.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+ "status": { # Contains information about current status of the HaController. # [Output Only] Status information for the HaController resource.
+ "failoverProgress": { # Contains information about the current failover operation. # [Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress.
+ "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or manually.
+ "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+ "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field is filled only if the current failover is failing
+ "errors": { # [Output Only] Encountered errors during the last attempt to process failover.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ "ongoingFailover": True or False, # [Output Only] Indicates if the failover is currently in-progress.
+ "primaryInstance": "A String", # [Output Only] The URL to the instance that is intended to be primary at this moment. Primary instance will be changed at the very beginning of a failover operation.
+ "primaryZone": "A String", # [Output Only] The name of the zone that is intended to be primary at this moment. Primary zone will be changed at the very beginning of a failover operation. The zone may not be operational in the middle of a failover operation.
+ "readyForFailover": True or False, # [Output Only] Indicates if the resource is ready for initiating a failover to the secondary zone.
+ "zoneStatus": { # [Output Only] Map of zone statuses. Key: name of the zone Value: ZoneStatus
+ "a_key": { # Contains the status of a specific zone.
+ "isPrimary": True or False, # [Output Only] Indicates if the zone is primary at this moment.
+ "isZoneReady": True or False, # [Output Only] Indicates if the zone is ready for initiating a failover.
+ "lastError": { # Contains details of the last failed operation. # [Output Only] This field is filled only if the current operation is failing.
+ "errors": { # [Output Only] Encountered errors.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ },
+ },
+ "zoneConfigurations": { # Map of zone configurations Key: name of the zone Value: ZoneConfiguration
+ "a_key": { # Config for a zone that the HaController may use for running the VM instance.
+ "nodeAffinities": [ # A set of node affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
+ { # Node Affinity: the configuration of desired nodes onto which the Instance could be scheduled. This message should be an exact copy of the Instances representation of NodeAffinity. LINT.IfChange(HaControllerNodeAffinityMixer)
+ "key": "A String", # Corresponds to the label key of Node resource.
+ "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
+ "values": [ # Corresponds to the label values of Node resource.
+ "A String",
+ ],
+ },
+ ],
+ "reservationAffinity": { # Specifies the reservations that this instance can consume from. This message should be an exact copy of the Instances representation of AllocationAffinity. LINT.IfChange(HaControllerAllocationAffinityMixer) # Specifies the reservations that the instance can consume from.
+ "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
+ "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
+ "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "nextPageToken": "A String", # This token allows you to get the next page of results for maxResults, 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", # [Output only] Server-defined URL for this resource.
+ "unreachables": [ # [Output only] Unreachable resources.
+ "A String",
+ ],
+ "warning": { # 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.
+ },
+}
+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(project, region, haController, body=None, requestId=None, updateMask=None, x__xgafv=None)
+ Updates HaController in the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ haController: string, ID of the HaController resource to update. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # HaController handles failover for a VM Instance.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "failoverInitiation": "A String", # Indicates how failover should be initiated.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "instanceName": "A String", # Name of the instance that HaController is in charge of. If not specified the HaController's resource name will be used instead. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "kind": "compute#HaController", # [Output Only] Type of the resource. Always compute#haController for HaControllers.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "secondaryZoneCapacity": "A String", # Indicates the capacity guarantees in the secondary zone.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+ "status": { # Contains information about current status of the HaController. # [Output Only] Status information for the HaController resource.
+ "failoverProgress": { # Contains information about the current failover operation. # [Output Only] Contains the details of the ongoing failover. This message is not displayed if failover is NOT in progress.
+ "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or manually.
+ "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+ "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field is filled only if the current failover is failing
+ "errors": { # [Output Only] Encountered errors during the last attempt to process failover.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ "ongoingFailover": True or False, # [Output Only] Indicates if the failover is currently in-progress.
+ "primaryInstance": "A String", # [Output Only] The URL to the instance that is intended to be primary at this moment. Primary instance will be changed at the very beginning of a failover operation.
+ "primaryZone": "A String", # [Output Only] The name of the zone that is intended to be primary at this moment. Primary zone will be changed at the very beginning of a failover operation. The zone may not be operational in the middle of a failover operation.
+ "readyForFailover": True or False, # [Output Only] Indicates if the resource is ready for initiating a failover to the secondary zone.
+ "zoneStatus": { # [Output Only] Map of zone statuses. Key: name of the zone Value: ZoneStatus
+ "a_key": { # Contains the status of a specific zone.
+ "isPrimary": True or False, # [Output Only] Indicates if the zone is primary at this moment.
+ "isZoneReady": True or False, # [Output Only] Indicates if the zone is ready for initiating a failover.
+ "lastError": { # Contains details of the last failed operation. # [Output Only] This field is filled only if the current operation is failing.
+ "errors": { # [Output Only] Encountered errors.
+ "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.
+ },
+ ],
+ },
+ "timestamp": "A String", # [Output Only] Show timestamp only if there is an error. RFC3339 text format.
+ },
+ },
+ },
+ },
+ "zoneConfigurations": { # Map of zone configurations Key: name of the zone Value: ZoneConfiguration
+ "a_key": { # Config for a zone that the HaController may use for running the VM instance.
+ "nodeAffinities": [ # A set of node affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
+ { # Node Affinity: the configuration of desired nodes onto which the Instance could be scheduled. This message should be an exact copy of the Instances representation of NodeAffinity. LINT.IfChange(HaControllerNodeAffinityMixer)
+ "key": "A String", # Corresponds to the label key of Node resource.
+ "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
+ "values": [ # Corresponds to the label values of Node resource.
+ "A String",
+ ],
+ },
+ ],
+ "reservationAffinity": { # Specifies the reservations that this instance can consume from. This message should be an exact copy of the Instances representation of AllocationAffinity. LINT.IfChange(HaControllerAllocationAffinityMixer) # Specifies the reservations that the instance can consume from.
+ "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
+ "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
+ "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
+ "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.
+ 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
+ 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, read Handling 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 in RFC3339 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.
+ },
+ ],
+ },
+ "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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # [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] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # [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 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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+ "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 in RFC3339 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.
+}
+