diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 5deef6364b..054d0015e6 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -257,6 +257,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -317,6 +320,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -388,6 +403,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -482,6 +498,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -706,6 +723,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -766,6 +786,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -862,6 +894,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -956,6 +989,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1442,6 +1476,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1502,6 +1539,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1598,6 +1647,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1692,6 +1742,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 72d31963c1..c8b7c3e314 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -231,6 +231,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -325,6 +326,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -562,6 +564,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -656,6 +659,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -918,6 +922,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1012,6 +1017,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1260,6 +1266,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1354,6 +1361,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1610,6 +1618,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1704,6 +1713,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1942,6 +1952,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2036,6 +2047,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html index a00c2affa0..31dd0c59e7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.dataLabelingJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.dataLabelingJobs.operations.html index 4ed33ac286..f1ef502d8c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.dataLabelingJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.dataLabelingJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.annotationSpecs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.annotationSpecs.operations.html index 8f41adecc4..af3ab8ffa6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.annotationSpecs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.annotationSpecs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.operations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.operations.html index 1af2fb663e..5bd01ec378 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.operations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.operations.html index 6775b267a9..2e9521d579 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.operations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.operations.html index ba9ef16b92..c15e45dfe3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.savedQueries.operations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.savedQueries.operations.html index e8b49b60df..2287b13cf5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.savedQueries.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.savedQueries.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.operations.html b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.operations.html index b59fe274bf..f56eaf01fa 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 5e76119e92..0e540dd1e4 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -325,6 +325,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -385,6 +388,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -456,6 +471,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -550,6 +566,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1668,6 +1685,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1728,6 +1748,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1824,6 +1856,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1918,6 +1951,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -3881,6 +3915,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3941,6 +3978,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4037,6 +4086,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -4131,6 +4181,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html index ae8f4d846e..25fd435b25 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index e040119218..a7097e7049 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -171,6 +171,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -231,6 +234,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -263,6 +278,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -323,6 +341,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -357,6 +387,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -417,6 +450,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -474,6 +519,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -534,6 +582,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -562,6 +622,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -622,6 +685,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -679,6 +754,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -739,6 +817,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -786,6 +876,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -846,6 +939,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -863,7 +968,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -919,6 +1024,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -979,6 +1087,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1011,6 +1131,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1071,6 +1194,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1105,6 +1240,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1165,6 +1303,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1222,6 +1372,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1282,6 +1435,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1310,6 +1475,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1370,6 +1538,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1427,6 +1607,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1487,6 +1670,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1534,6 +1729,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1594,6 +1792,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1611,7 +1821,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -1709,6 +1919,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1769,6 +1982,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1801,6 +2026,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1861,6 +2089,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1895,6 +2135,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1955,6 +2198,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2012,6 +2267,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2072,6 +2330,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2100,6 +2370,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2160,6 +2433,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2217,6 +2502,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2277,6 +2565,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2324,6 +2624,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2384,6 +2687,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2401,7 +2716,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -2470,6 +2785,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2530,6 +2848,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2562,6 +2892,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2622,6 +2955,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2656,6 +3001,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2716,6 +3064,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2773,6 +3133,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2833,6 +3196,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2861,6 +3236,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2921,6 +3299,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2978,6 +3368,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3038,6 +3431,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3085,6 +3490,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3145,6 +3553,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3162,7 +3582,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html index 281f6058d1..e4d62e035f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

listWait_next()

@@ -152,7 +152,7 @@

Method Details

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.operations.html index 7a9aafee3e..f0cadcdf7d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

listWait_next()

@@ -152,7 +152,7 @@

Method Details

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index 7fdf0dc7c9..53e825c613 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -99,6 +99,9 @@

Instance Methods

fetchFeatureValues(featureView, body=None, x__xgafv=None)

Fetch feature values under a FeatureView.

+

+ generateFetchAccessToken(featureView, body=None, x__xgafv=None)

+

RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.

get(name, x__xgafv=None)

Gets details of a single FeatureView.

@@ -148,6 +151,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -456,6 +462,32 @@

Method Details

} +
+ generateFetchAccessToken(featureView, body=None, x__xgafv=None) +
RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
+
+Args:
+  featureView: string, FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+}
+
+  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 FeatureOnlineStoreService.GenerateFetchAccessToken.
+  "accessToken": "A String", # The OAuth 2.0 access token.
+  "expireTime": "A String", # Token expiration time. This is always set
+}
+
+
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -477,6 +509,9 @@ 

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -592,6 +627,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -678,6 +716,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html index 0e63c82eab..e3129d6a41 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

listWait_next()

@@ -152,7 +152,7 @@

Method Details

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html index 381d2e0c5d..29e627b8ae 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html @@ -136,6 +136,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -262,6 +268,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -364,6 +376,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -437,6 +455,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html index f0aca295ef..1a086ccf5b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

listWait_next()

@@ -152,7 +152,7 @@

Method Details

- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.operations.html index 47a26c5759..2d6e98b80e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.operations.html index 919561ce85..a074e6132f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.operations.html index 95c1f1722a..cf2bde359e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 76bf68c1ff..0bada57bfb 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -620,6 +620,9 @@

Method Details

"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. + "labels": { # Optional. The labels with user-defined metadata to organize your Endpoints. 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", + }, "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. @@ -822,6 +825,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -882,6 +888,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -933,6 +951,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -993,6 +1014,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1028,6 +1061,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1088,6 +1124,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1199,6 +1247,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1259,6 +1310,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1599,6 +1662,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1659,6 +1725,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1694,6 +1772,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1754,6 +1835,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2586,6 +2679,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2646,6 +2742,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html index 949db64010..f8ee388a9d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index 9bdd46ae00..b8eb70f974 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -175,7 +175,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -360,7 +360,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -610,7 +610,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -745,7 +745,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -883,7 +883,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -999,7 +999,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -1122,7 +1122,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html index d3b94cb0bb..676b781153 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexes.operations.html b/docs/dyn/aiplatform_v1.projects.locations.indexes.operations.html index da9b028d21..7fb4d9dc4a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexes.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.operations.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.operations.html index c191cf2810..617bfb2771 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.operations.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.operations.html index d2b2e686dc..28c78bd1dc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.operations.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.operations.html index f282a1bc75..f304b522d3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.operations.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.operations.html index 3a2f81b762..79855a20e9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.migratableResources.operations.html b/docs/dyn/aiplatform_v1.projects.locations.migratableResources.operations.html index 5c6c5bfec3..f3260576b8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.migratableResources.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.migratableResources.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.operations.html index 6ec9d650f9..a8103e7e08 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.evaluations.operations.html b/docs/dyn/aiplatform_v1.projects.locations.models.evaluations.operations.html index 6ce15ef774..55469084fd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.models.evaluations.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.models.evaluations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.operations.html b/docs/dyn/aiplatform_v1.projects.locations.models.operations.html index d0fca414c4..eb878e3a6b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.models.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.models.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.operations.html index e253e9678c..0845fcb200 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.operations.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.operations.html index a82ef1ac3b..b2cfe7598d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.operations.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.operations.html index 39a7c0c0f7..36245b1321 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.operations.html b/docs/dyn/aiplatform_v1.projects.locations.operations.html index c21ac9c250..e58ce6f9a7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.operations.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.operations.html index a8883e8820..d917626b7f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.operations.html index 372f1edf6d..ce6c7201d7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 8d8227c6db..a18b4bc01c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -261,6 +261,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -321,6 +324,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -392,6 +407,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -486,6 +502,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -710,6 +727,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -770,6 +790,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -866,6 +898,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -960,6 +993,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1674,6 +1708,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1734,6 +1771,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1830,6 +1879,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1924,6 +1974,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html index 778111257e..7274d12ee7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html index 7e8c0be055..2137a52aac 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragEngineConfig.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragEngineConfig.operations.html index 495aab6454..d75f848c77 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.ragEngineConfig.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.ragEngineConfig.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.operations.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.operations.html index 28a6479ec8..c3a008998e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.schedules.operations.html b/docs/dyn/aiplatform_v1.projects.locations.schedules.operations.html index 70d9eb6a19..3b542539d3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.schedules.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.schedules.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.specialistPools.operations.html b/docs/dyn/aiplatform_v1.projects.locations.specialistPools.operations.html index c1a4e2ea57..b41e1fbdb0 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.specialistPools.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.specialistPools.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.studies.operations.html b/docs/dyn/aiplatform_v1.projects.locations.studies.operations.html index 6ac87560a4..fca639645d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.studies.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.studies.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.studies.trials.operations.html b/docs/dyn/aiplatform_v1.projects.locations.studies.trials.operations.html index 1588284a9c..77b28bc40c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.studies.trials.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.studies.trials.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.operations.html index 5f2b27b550..ba971949fd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.operations.html index 3a0d5a9d08..cb6f5a7a51 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html index 24277073c9..218da46f13 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.operations.html index de306f329a..3b5921b96a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tensorboards.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tensorboards.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.operations.html b/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.operations.html index 81baf42e37..d05a707fd5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 1d229981d3..6de0884a27 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -161,6 +161,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "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}` + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "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. @@ -184,9 +189,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. @@ -334,6 +339,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "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}` + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "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. @@ -357,9 +367,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. @@ -514,6 +524,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "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}` + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "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. @@ -537,9 +552,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. @@ -700,6 +715,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "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}` + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "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. @@ -723,9 +743,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. @@ -901,6 +921,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "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}` + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "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. @@ -924,9 +949,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html index 247de0bc9a..609ff00145 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index db23a16937..db0830266e 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -255,6 +255,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -315,6 +318,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -386,6 +401,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -480,6 +496,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -704,6 +721,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -764,6 +784,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -860,6 +892,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -954,6 +987,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -2013,6 +2047,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2073,6 +2110,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2169,6 +2218,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2263,6 +2313,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 267867ecca..7bbf4858e7 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -261,6 +261,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -324,6 +327,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -397,6 +412,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -491,6 +507,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -724,6 +741,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -787,6 +807,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -885,6 +917,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -979,6 +1012,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1479,6 +1513,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1542,6 +1579,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1640,6 +1689,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1734,6 +1784,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html index 0488ae8b8a..bbd95652ba 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.apps.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.apps.operations.html index ac856babdf..d6e68ea9c4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.apps.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.apps.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 6dd79b5ef1..74f6eb2c7d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -235,6 +235,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -329,6 +330,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -577,6 +579,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -671,6 +674,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -944,6 +948,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1038,6 +1043,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1297,6 +1303,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1391,6 +1398,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1658,6 +1666,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1752,6 +1761,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -2001,6 +2011,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2095,6 +2106,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html index dc573a0833..d9b579cff8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.dataLabelingJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.dataLabelingJobs.operations.html index 3de6b43e3b..689c0a5085 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.dataLabelingJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.dataLabelingJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.annotationSpecs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.annotationSpecs.operations.html index 0760e42450..e2d7f494cb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.annotationSpecs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.annotationSpecs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.operations.html index 01e8e6c852..79b3397236 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.operations.html index 4df85bab4e..a29ee77e8e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index bdd99c921f..491cae7507 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -211,6 +211,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -274,6 +277,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -369,6 +384,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -463,6 +479,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -679,6 +696,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -742,6 +762,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -837,6 +869,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -931,6 +964,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html index 896aedf5c4..46476aaa4e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.savedQueries.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.savedQueries.operations.html index 476fab18fa..86af4315b1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.savedQueries.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.savedQueries.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html index 6534181095..3e2d6ea75f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html @@ -137,6 +137,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -155,6 +156,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -262,6 +267,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -280,6 +286,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -326,6 +336,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -344,6 +355,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -398,6 +413,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -416,6 +432,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -503,6 +523,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -521,6 +542,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html index 71c0f6f2dd..9a68c98cc5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.edgeDevices.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.edgeDevices.operations.html index a88e044587..6cfcc1182c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.edgeDevices.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.edgeDevices.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 83005a1810..7774dc3b60 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -338,6 +338,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -401,6 +404,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -474,6 +489,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -568,6 +584,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -731,6 +748,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -749,6 +767,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -1062,6 +1084,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -1080,6 +1103,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -1870,6 +1897,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1933,6 +1963,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2031,6 +2073,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2125,6 +2168,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -2521,6 +2565,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -2539,6 +2584,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -2842,6 +2891,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -2860,6 +2910,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -3126,6 +3180,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -3144,6 +3199,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -3374,6 +3433,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -3392,6 +3452,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -3647,6 +3711,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -3665,6 +3730,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. @@ -4316,6 +4385,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4379,6 +4451,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4477,6 +4561,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -4571,6 +4656,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -5070,6 +5156,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -5088,6 +5175,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html index 919eda45ad..bb6e5055d8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.operations.html index 80393f7e45..1cf82db285 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index efb397b4b5..9cd3192e43 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -176,6 +176,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -239,6 +242,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -271,6 +286,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -334,6 +352,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -368,6 +398,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -431,6 +464,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -488,6 +533,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -551,6 +599,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -579,6 +639,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -642,6 +705,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -699,6 +774,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -762,6 +840,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -809,6 +899,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -872,6 +965,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -889,7 +994,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -945,6 +1050,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1008,6 +1116,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1040,6 +1160,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1103,6 +1226,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1137,6 +1272,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1200,6 +1338,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1257,6 +1407,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1320,6 +1473,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1348,6 +1513,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1411,6 +1579,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1468,6 +1648,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1531,6 +1714,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1578,6 +1773,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1641,6 +1839,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1658,7 +1868,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -1756,6 +1966,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1819,6 +2032,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1851,6 +2076,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1914,6 +2142,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1948,6 +2188,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2011,6 +2254,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2068,6 +2323,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2131,6 +2389,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2159,6 +2429,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2222,6 +2495,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2279,6 +2564,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2342,6 +2630,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2389,6 +2689,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2452,6 +2755,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2469,7 +2784,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -2538,6 +2853,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2601,6 +2919,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2633,6 +2963,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2696,6 +3029,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2730,6 +3075,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2793,6 +3141,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2850,6 +3210,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2913,6 +3276,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2941,6 +3316,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3004,6 +3382,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3061,6 +3451,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3124,6 +3517,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3171,6 +3576,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3234,6 +3642,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3251,7 +3671,7 @@

Method Details

"topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html index 632b076d8a..1298a2b25c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.operations.html index df04290038..51c12c187a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationTasks.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationTasks.operations.html index b3d2885cfa..bcdd8bec9b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationTasks.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationTasks.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.operations.html index 83841b0aef..4e0a969d4a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensionControllers.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensionControllers.operations.html index 93de51e178..fedc3fc0f4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensionControllers.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensionControllers.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.operations.html index e294b01548..ee0072f9cd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.operations.html index 00136fec5d..2a66cd6898 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.operations.html index 2ecdc7c001..04ca4a3fb4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.operations.html index d0358fb72c..0b0d269160 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index cdfb9b0d1e..d696b3d0ea 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -99,6 +99,9 @@

Instance Methods

fetchFeatureValues(featureView, body=None, x__xgafv=None)

Fetch feature values under a FeatureView.

+

+ generateFetchAccessToken(featureView, body=None, x__xgafv=None)

+

RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.

get(name, x__xgafv=None)

Gets details of a single FeatureView.

@@ -151,6 +154,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -516,6 +522,32 @@

Method Details

} +
+ generateFetchAccessToken(featureView, body=None, x__xgafv=None) +
RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
+
+Args:
+  featureView: string, FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+}
+
+  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 FeatureOnlineStoreService.GenerateFetchAccessToken.
+  "accessToken": "A String", # The OAuth 2.0 access token.
+  "expireTime": "A String", # Token expiration time. This is always set
+}
+
+
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -537,6 +569,9 @@ 

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -666,6 +701,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. @@ -766,6 +804,9 @@

Method Details

], "uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. }, + "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable. + "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable. + }, "createTime": "A String", # Output only. Timestamp when this FeatureView was created. "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html index cd9875e9de..0d7c94b3d1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html index 7554eca2ee..f7050ef5d8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html @@ -136,6 +136,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -266,6 +272,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -372,6 +384,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. @@ -449,6 +467,12 @@

Method Details

"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. "minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. }, + "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only. + "instanceId": "A String", # The Cloud Bigtable instance id. + "tableId": "A String", # The Cloud Bigtable table id. + "tenantProjectId": "A String", # Tenant project ID. + }, + "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance. }, "createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created. "dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html index 22fc45fccc..13f0857e40 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.features.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.features.operations.html index 1a1dccb6e1..95f25a8498 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.features.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.features.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.operations.html index 419bde2f59..abd6b1e889 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.operations.html index ba55f03bef..97f215d355 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index e72e45f488..401f455ee6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -666,6 +666,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -684,6 +685,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "fastTryoutEnabled": True or False, # Optional. If true, enable the QMT fast tryout feature for this model if possible. @@ -696,6 +701,9 @@

Method Details

"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. + "labels": { # Optional. The labels with user-defined metadata to organize your Endpoints. 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", + }, "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. "enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled. @@ -905,6 +913,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -923,6 +932,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used. @@ -978,6 +991,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1041,6 +1057,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1092,6 +1120,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1155,6 +1186,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1190,6 +1233,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1253,6 +1299,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1364,6 +1422,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1427,6 +1488,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1775,6 +1848,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1838,6 +1914,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1873,6 +1961,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1936,6 +2027,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2774,6 +2877,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2837,6 +2943,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html index b9b3ffb080..da5a851ba8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index 5076808895..c25000316d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -152,6 +152,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -170,6 +171,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -183,7 +188,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -346,6 +351,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -364,6 +370,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -377,7 +387,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -604,6 +614,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -622,6 +633,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -635,7 +650,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -748,6 +763,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -766,6 +782,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -779,7 +799,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -895,6 +915,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -913,6 +934,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -926,7 +951,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -1019,6 +1044,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -1037,6 +1063,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -1050,7 +1080,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. @@ -1151,6 +1181,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -1169,6 +1200,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint. @@ -1182,7 +1217,7 @@

Method Details

}, }, "deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). - "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier. "displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. "enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. "enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html index d65d85540e..5d6a55b827 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.operations.html index 66886e7190..e26786c5af 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.operations.html index 3639d3e3fb..a57527cd6f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.operations.html index 5e9338b2db..c4daebf201 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.operations.html index 0a8c4ba338..d08466569f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.operations.html index f8abe9e983..e023ea9862 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.migratableResources.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.migratableResources.operations.html index 35cd3f0c9e..d81fa4bc8f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.migratableResources.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.migratableResources.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.operations.html index 1434d4a358..d1535e421e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.operations.html index eb27331412..8ff9c38954 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.models.evaluations.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.models.evaluations.operations.html index 8f24da9f9e..7f985bd2fd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.models.evaluations.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.models.evaluations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.models.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.models.operations.html index 01eff45710..9e0910c6d4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.models.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.models.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.operations.html index 9c991fd995..9164fc279b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.operations.html index 53dd4a7d48..48d54a2b6b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.operations.html index 29f7b3b56a..32775ff134 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.operations.html index e8bcc22bcc..c2957ac37a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.operations.html index 489e1ffe16..248af7f3df 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.operations.html index 6dec31ce86..c9664aab6d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 7956405d9b..d09592ddbe 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -277,6 +277,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -340,6 +343,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -413,6 +428,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -507,6 +523,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -812,6 +829,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -875,6 +895,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -973,6 +1005,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1067,6 +1100,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1882,6 +1916,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1945,6 +1982,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2043,6 +2092,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2137,6 +2187,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html index ebe0738fcc..e7494fefb8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.operations.html index 356efc0b53..5dc88cb8a0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragEngineConfig.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragEngineConfig.operations.html index af50b0c1e2..9d3aa970c6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragEngineConfig.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragEngineConfig.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.operations.html index 927bd4ab08..bf95bc48d4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.operations.html index 2b4256a03a..c62b7f767d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html index dbe8a10df2..1f90a20867 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -116,6 +116,11 @@

Method Details

The object takes the form of: { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. + "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. + "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. + "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. + }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. @@ -125,6 +130,8 @@

Method Details

"codeLanguage": "A String", # The coding language supported in this environment. "machineConfig": "A String", # The machine config of the code execution environment. }, + "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment. + }, }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -256,6 +263,11 @@

Method Details

An object of the form: { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. + "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. + "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. + "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. + }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. @@ -265,6 +277,8 @@

Method Details

"codeLanguage": "A String", # The coding language supported in this environment. "machineConfig": "A String", # The machine config of the code execution environment. }, + "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment. + }, }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -293,6 +307,11 @@

Method Details

"nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. "sandboxEnvironments": [ # The SandboxEnvironments matching the request. { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. + "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. + "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. + "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. + }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. @@ -302,6 +321,8 @@

Method Details

"codeLanguage": "A String", # The coding language supported in this environment. "machineConfig": "A String", # The machine config of the code execution environment. }, + "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment. + }, }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html index 2effd706de..0ceb370f4d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.operations.html index 3bdc84d168..ac69494f69 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.operations.html index 43bdc8e9d5..98af2a76c2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.solvers.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.solvers.operations.html index cef31b91f9..1303328827 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.solvers.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.solvers.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.specialistPools.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.specialistPools.operations.html index 86e73c25e3..ab4e21828a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.specialistPools.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.specialistPools.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.studies.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.studies.operations.html index cb507363e5..9315c8d102 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.studies.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.studies.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.studies.trials.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.studies.trials.operations.html index 9d409730c9..d35f219561 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.studies.trials.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.studies.trials.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.operations.html index 681836566b..f8323bf30a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.operations.html index 15e85ce844..0f4ffe0a7f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html index 53d80bfee6..3e3948b6b2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.operations.html index b0777452cf..5f370b3923 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tensorboards.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.operations.html index 728ba30b8d..28124ab764 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index b7886cd9a3..9371b782ef 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -242,6 +242,17 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, "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", }, @@ -270,6 +281,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -333,6 +347,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -374,6 +400,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -437,6 +466,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -472,6 +513,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -535,6 +579,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -623,6 +679,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -686,6 +745,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -727,6 +798,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -790,6 +864,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -825,6 +911,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -888,6 +977,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -973,9 +1074,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "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. @@ -1504,6 +1605,17 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, "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", }, @@ -1532,6 +1644,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1595,6 +1710,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1636,6 +1763,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1699,6 +1829,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1734,6 +1876,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1797,6 +1942,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1885,6 +2042,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1948,6 +2108,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -1989,6 +2161,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2052,6 +2227,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2087,6 +2274,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2150,6 +2340,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2235,9 +2437,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "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. @@ -2773,6 +2975,17 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, "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", }, @@ -2801,6 +3014,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2864,6 +3080,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2905,6 +3133,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2968,6 +3199,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3003,6 +3246,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3066,6 +3312,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3154,6 +3412,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3217,6 +3478,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3258,6 +3531,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3321,6 +3597,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3356,6 +3644,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -3419,6 +3710,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -3504,9 +3807,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "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. @@ -4048,6 +4351,17 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, "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", }, @@ -4076,6 +4390,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4139,6 +4456,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4180,6 +4509,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4243,6 +4575,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4278,6 +4622,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4341,6 +4688,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4429,6 +4788,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4492,6 +4854,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4533,6 +4907,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4596,6 +4973,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4631,6 +5020,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -4694,6 +5086,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -4779,9 +5183,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "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. @@ -5456,6 +5860,17 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, "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", }, @@ -5484,6 +5899,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -5547,6 +5965,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -5588,6 +6018,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -5651,6 +6084,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -5686,6 +6131,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -5749,6 +6197,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -5837,6 +6297,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -5900,6 +6363,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -5941,6 +6416,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -6004,6 +6482,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -6039,6 +6529,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -6102,6 +6595,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -6187,9 +6692,9 @@

Method Details

}, ], "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` + "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` }, - "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "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. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index d292f7abe1..07105cac91 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -265,6 +265,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -328,6 +331,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -401,6 +416,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -495,6 +511,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -728,6 +745,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -791,6 +811,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -889,6 +921,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -983,6 +1016,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1545,6 +1579,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -1563,6 +1598,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -1732,6 +1771,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -1750,6 +1790,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -2149,6 +2193,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -2167,6 +2212,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -2336,6 +2385,7 @@

Method Details

"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days. }, + "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count. "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used. "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. @@ -2354,6 +2404,10 @@

Method Details

"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) + }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config. @@ -2702,6 +2756,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -2765,6 +2822,18 @@

Method Details

"seed": 42, # Optional. Seed. "speechConfig": { # The speech generation config. # Optional. The speech generation config. "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. + "voiceName": "A String", # The name of the preset voice to use. + }, + }, + }, + ], + }, "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. "voiceName": "A String", # The name of the preset voice to use. @@ -2863,6 +2932,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -2957,6 +3027,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index 6f7bc5dc4d..9cebe06928 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -297,6 +297,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -537,6 +538,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -885,6 +887,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1160,6 +1163,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1389,6 +1393,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1686,6 +1691,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1937,6 +1943,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index c4d9813ddf..48dcd8de90 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -297,6 +297,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -536,6 +537,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -883,6 +885,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1157,6 +1160,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1385,6 +1389,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1681,6 +1686,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. @@ -1931,6 +1937,7 @@

Method Details

}, ], }, + "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. "migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration. "hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format "referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster. diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index 05918af8c2..f44af95f5c 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -204,6 +204,18 @@

Method Details

"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled. "policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification. }, + "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information. + { # The default application information for a specific DefaultApplicationType. + "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications. + { # Details on a default application setting attempt. + "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default. + "packageName": "A String", # Output only. The package name of the attempted application. + }, + ], + "defaultApplicationType": "A String", # Output only. The default application type. + "packageName": "A String", # Output only. The package name of the current default application. + }, + ], "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. @@ -338,6 +350,9 @@

Method Details

"packageName": "A String", # The package name indicating which app is out of compliance, if applicable. "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. "specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason. + "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE. + "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting. + }, "oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL "wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration. }, @@ -621,6 +636,18 @@

Method Details

"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled. "policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification. }, + "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information. + { # The default application information for a specific DefaultApplicationType. + "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications. + { # Details on a default application setting attempt. + "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default. + "packageName": "A String", # Output only. The package name of the attempted application. + }, + ], + "defaultApplicationType": "A String", # Output only. The default application type. + "packageName": "A String", # Output only. The package name of the current default application. + }, + ], "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. @@ -755,6 +782,9 @@

Method Details

"packageName": "A String", # The package name indicating which app is out of compliance, if applicable. "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. "specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason. + "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE. + "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting. + }, "oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL "wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration. }, @@ -906,6 +936,18 @@

Method Details

"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled. "policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification. }, + "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information. + { # The default application information for a specific DefaultApplicationType. + "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications. + { # Details on a default application setting attempt. + "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default. + "packageName": "A String", # Output only. The package name of the attempted application. + }, + ], + "defaultApplicationType": "A String", # Output only. The default application type. + "packageName": "A String", # Output only. The package name of the current default application. + }, + ], "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. @@ -1040,6 +1082,9 @@

Method Details

"packageName": "A String", # The package name indicating which app is out of compliance, if applicable. "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. "specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason. + "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE. + "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting. + }, "oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL "wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration. }, @@ -1173,6 +1218,18 @@

Method Details

"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled. "policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification. }, + "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information. + { # The default application information for a specific DefaultApplicationType. + "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications. + { # Details on a default application setting attempt. + "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default. + "packageName": "A String", # Output only. The package name of the attempted application. + }, + ], + "defaultApplicationType": "A String", # Output only. The default application type. + "packageName": "A String", # Output only. The package name of the current default application. + }, + ], "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. @@ -1307,6 +1364,9 @@

Method Details

"packageName": "A String", # The package name indicating which app is out of compliance, if applicable. "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. "specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason. + "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE. + "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting. + }, "oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL "wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration. }, diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 71f4aa3a8d..f0e627fc8c 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -147,7 +147,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -279,6 +279,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -567,6 +580,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. @@ -655,7 +669,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -787,6 +801,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -1075,6 +1102,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. @@ -1249,7 +1277,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -1381,6 +1409,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -1669,6 +1710,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. @@ -1748,7 +1790,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -1880,6 +1922,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -2168,6 +2223,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. @@ -2245,7 +2301,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -2377,6 +2433,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -2665,6 +2734,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. @@ -2758,7 +2828,7 @@

Method Details

"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). - "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. + "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], @@ -2890,6 +2960,19 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + { # The default application setting for a DefaultApplicationType. + "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). + "A String", + ], + "defaultApplicationType": "A String", # Required. The app type to set the default application. + "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile. + { # Information about the application to be set as the default. + "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid. + }, + ], + }, + ], "defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests. "deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. "apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. @@ -3178,6 +3261,7 @@

Method Details

}, "applicationReportsEnabled": True or False, # Whether app reports are enabled. "commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. + "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled. "deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled. "displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. "hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.html b/docs/dyn/baremetalsolution_v2.projects.locations.html index d78a6b081b..0ab544dac8 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.html @@ -170,7 +170,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/bigquerydatapolicy_v2.html b/docs/dyn/bigquerydatapolicy_v2.html new file mode 100644 index 0000000000..ffe6c6438c --- /dev/null +++ b/docs/dyn/bigquerydatapolicy_v2.html @@ -0,0 +1,111 @@ + + + +

BigQuery Data Policy API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/bigquerydatapolicy_v2.projects.html b/docs/dyn/bigquerydatapolicy_v2.projects.html new file mode 100644 index 0000000000..6a25e812ab --- /dev/null +++ b/docs/dyn/bigquerydatapolicy_v2.projects.html @@ -0,0 +1,91 @@ + + + +

BigQuery Data Policy API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html b/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html new file mode 100644 index 0000000000..7370f84e7b --- /dev/null +++ b/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html @@ -0,0 +1,577 @@ + + + +

BigQuery Data Policy API . projects . locations . dataPolicies

+

Instance Methods

+

+ addGrantees(dataPolicy, body=None, x__xgafv=None)

+

Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type.

+

+ delete(name, x__xgafv=None)

+

Deletes the data policy specified by its resource name.

+

+ get(name, x__xgafv=None)

+

Gets the data policy specified by its resource name.

+

+ getIamPolicy(resource, body=None, x__xgafv=None)

+

Gets the IAM policy for the specified data policy.

+

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

+

List all of the data policies in the specified parent project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)

+

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

+

+ removeGrantees(dataPolicy, body=None, x__xgafv=None)

+

Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM policy for the specified data policy.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns the caller's permission on the specified data policy resource.

+

Method Details

+
+ addGrantees(dataPolicy, body=None, x__xgafv=None) +
Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored.
+
+Args:
+  dataPolicy: string, Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the AddGrantees method.
+  "grantees": [ # Required. IAM principal that should be granted Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type.
+
+Args:
+  parent: string, Required. Resource name of the project that the data policy will belong to. The format is `projects/{project_number}/locations/{location_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the CreateDataPolicy method.
+  "dataPolicy": { # Represents the label-policy binding. # Required. The data policy to create. The `name` field does not need to be provided for the data policy creation.
+    "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+      "predefinedExpression": "A String", # Optional. A predefined masking expression.
+      "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+    },
+    "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+    "dataPolicyType": "A String", # Required. Type of data policy.
+    "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+    "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+      "A String",
+    ],
+    "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+    "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+    "version": "A String", # Output only. The version of the Data Policy resource.
+  },
+  "dataPolicyId": "A String", # Required. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the data policy specified by its resource name.
+
+Args:
+  name: string, Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the data policy specified by its resource name.
+
+Args:
+  name: string, Required. Resource name of the requested data policy. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ +
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the IAM policy for the specified data policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List all of the data policies in the specified parent project.
+
+Args:
+  parent: string, Required. Resource name of the project for which to list data policies. Format is `projects/{project_number}/locations/{location_id}`. (required)
+  filter: string, Optional. Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.
+  pageSize: integer, Optional. The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
+  pageToken: string, Optional. The `nextPageToken` value returned from a previous list request, if any. If not set, defaults to an empty string.
+  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 the ListDataPolicies method.
+  "dataPolicies": [ # Data policies that belong to the requested project.
+    { # Represents the label-policy binding.
+      "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+        "predefinedExpression": "A String", # Optional. A predefined masking expression.
+        "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+      },
+      "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+      "dataPolicyType": "A String", # Required. Type of data policy.
+      "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+      "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+        "A String",
+      ],
+      "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+      "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+      "version": "A String", # Output only. The version of the Data Policy resource.
+    },
+  ],
+  "nextPageToken": "A String", # Token used to retrieve the next page of results, or empty if there are no more results.
+}
+
+ +
+ 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, allowMissing=None, body=None, updateMask=None, x__xgafv=None) +
Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.
+
+Args:
+  name: string, Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+  allowMissing: boolean, Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.
+  updateMask: string, Optional. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the `name` and `dataPolicyId` fields are not allowed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ +
+ removeGrantees(dataPolicy, body=None, x__xgafv=None) +
Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored.
+
+Args:
+  dataPolicy: string, Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the RemoveGrantees method.
+  "grantees": [ # Required. IAM principal that should be revoked from Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the label-policy binding.
+  "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+    "predefinedExpression": "A String", # Optional. A predefined masking expression.
+    "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+  },
+  "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+  "dataPolicyType": "A String", # Required. Type of data policy.
+  "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+  "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+  "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+  "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the IAM policy for the specified data policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the caller's permission on the specified data policy resource.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/bigquerydatapolicy_v2.projects.locations.html b/docs/dyn/bigquerydatapolicy_v2.projects.locations.html new file mode 100644 index 0000000000..df7d376bd7 --- /dev/null +++ b/docs/dyn/bigquerydatapolicy_v2.projects.locations.html @@ -0,0 +1,91 @@ + + + +

BigQuery Data Policy API . projects . locations

+

Instance Methods

+

+ dataPolicies() +

+

Returns the dataPolicies Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index a4d8d0c457..6f88247173 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -168,6 +168,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. }, ], @@ -213,6 +217,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. }, ], diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 5781872d5c..70343381f8 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -124,6 +124,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. } @@ -141,6 +145,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. } @@ -234,6 +242,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. }, ], @@ -282,6 +294,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. } @@ -300,6 +316,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. } @@ -317,6 +337,10 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "state": "A String", # Output only. State of the assignment. } diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html index 38fe9d256a..c938890cb7 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html @@ -160,6 +160,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -207,6 +211,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -285,6 +293,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -338,6 +350,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -444,6 +460,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -508,6 +528,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -555,6 +579,10 @@

Method Details

}, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + }, "secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). "slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. "updateTime": "A String", # Output only. Last update time of the reservation. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html index a7c95b11d9..0febadc908 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets metadata information about the specified schema bundle.

+

+ getIamPolicy(resource, body=None, x__xgafv=None)

+

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

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

Lists all schema bundles associated with the specified table.

@@ -95,6 +98,12 @@

Instance Methods

patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)

Updates a schema bundle in the specified table.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that the caller has on the specified Bigtable resource.

Method Details

close() @@ -190,6 +199,62 @@

Method Details

}
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all schema bundles associated with the specified table.
@@ -288,4 +353,119 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that the caller has on the specified Bigtable resource.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index a84fb6cbac..3df2d5d05c 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -362,7 +362,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -652,7 +652,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1224,7 +1224,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1514,7 +1514,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2299,7 +2299,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2589,7 +2589,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2936,7 +2936,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -3291,7 +3291,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3581,7 +3581,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4153,7 +4153,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4443,7 +4443,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5228,7 +5228,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5518,7 +5518,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5865,7 +5865,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -6238,7 +6238,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -6528,7 +6528,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7100,7 +7100,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7390,7 +7390,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8175,7 +8175,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8465,7 +8465,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8812,7 +8812,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -9173,7 +9173,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -9463,7 +9463,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10035,7 +10035,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10325,7 +10325,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11110,7 +11110,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11400,7 +11400,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11747,7 +11747,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -12113,7 +12113,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12403,7 +12403,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12975,7 +12975,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13265,7 +13265,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14050,7 +14050,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14340,7 +14340,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14687,7 +14687,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -15036,7 +15036,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15326,7 +15326,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15898,7 +15898,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16188,7 +16188,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16973,7 +16973,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17263,7 +17263,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17610,7 +17610,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -17959,7 +17959,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18249,7 +18249,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18821,7 +18821,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19111,7 +19111,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19896,7 +19896,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20186,7 +20186,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20533,7 +20533,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -20882,7 +20882,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21172,7 +21172,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21744,7 +21744,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22034,7 +22034,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22819,7 +22819,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23109,7 +23109,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23456,7 +23456,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index aa07e24538..d55ca5e29d 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -477,7 +477,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -767,7 +767,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1339,7 +1339,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1629,7 +1629,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2414,7 +2414,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2704,7 +2704,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3051,7 +3051,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -3395,7 +3395,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3685,7 +3685,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4257,7 +4257,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4547,7 +4547,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5332,7 +5332,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5622,7 +5622,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5969,7 +5969,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -6313,7 +6313,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -6603,7 +6603,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7175,7 +7175,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7465,7 +7465,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8250,7 +8250,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8540,7 +8540,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8887,7 +8887,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -9229,7 +9229,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -9519,7 +9519,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10091,7 +10091,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10381,7 +10381,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11166,7 +11166,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11456,7 +11456,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11803,7 +11803,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -12143,7 +12143,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12433,7 +12433,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13005,7 +13005,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13295,7 +13295,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14080,7 +14080,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14370,7 +14370,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14717,7 +14717,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -15057,7 +15057,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15347,7 +15347,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15919,7 +15919,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16209,7 +16209,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16994,7 +16994,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17284,7 +17284,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17631,7 +17631,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -18372,7 +18372,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18662,7 +18662,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19234,7 +19234,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19524,7 +19524,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20309,7 +20309,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20599,7 +20599,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20946,7 +20946,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -21290,7 +21290,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21580,7 +21580,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22152,7 +22152,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22442,7 +22442,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23227,7 +23227,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23517,7 +23517,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23864,7 +23864,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -24208,7 +24208,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -24498,7 +24498,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -25070,7 +25070,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -25360,7 +25360,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26145,7 +26145,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26435,7 +26435,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26782,7 +26782,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -27124,7 +27124,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -27414,7 +27414,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -27986,7 +27986,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -28276,7 +28276,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29061,7 +29061,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29351,7 +29351,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29698,7 +29698,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -30038,7 +30038,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -30328,7 +30328,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -30900,7 +30900,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -31190,7 +31190,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -31975,7 +31975,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -32265,7 +32265,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -32612,7 +32612,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. @@ -32952,7 +32952,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -33242,7 +33242,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -33814,7 +33814,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -34104,7 +34104,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -34889,7 +34889,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -35179,7 +35179,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -35526,7 +35526,7 @@

Method Details

}, ], "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. - "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) + "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html index 354e1b5f77..b82c758ac4 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html @@ -314,8 +314,14 @@

Method Details

"connectionType": "A String", # Output only. Network connection type. "encryptionOn": True or False, # Output only. Whether the wifi encryption key is turned off. "gatewayIpAddress": "A String", # Output only. Gateway IP address. + "gatewayIpv6Address": "A String", # Output only. The gateway IPv6 for this interface, if detected "guid": "A String", # Output only. Network connection guid. + "ipv6Address": [ # Output only. IPv6 addresses assigned to this network, if any. Each address is a string in standard IPv6 text representation (e.g., "2001:db8::1"). + "A String", + ], "lanIpAddress": "A String", # Output only. LAN IP address. + "linkDownSpeedKbps": "A String", # Output only. The maximum downstream bandwidth in Kilobits per second (Kbps), if reported by the network interface or connection. + "metered": True or False, # Output only. Whether the network was detected as metered. "receivingBitRateMbps": "A String", # Output only. Receiving bit rate measured in Megabits per second. "reportTime": "A String", # Output only. Time at which the network state was reported. "sampleFrequency": "A String", # Output only. Frequency the report is sampled. @@ -636,8 +642,14 @@

Method Details

"connectionType": "A String", # Output only. Network connection type. "encryptionOn": True or False, # Output only. Whether the wifi encryption key is turned off. "gatewayIpAddress": "A String", # Output only. Gateway IP address. + "gatewayIpv6Address": "A String", # Output only. The gateway IPv6 for this interface, if detected "guid": "A String", # Output only. Network connection guid. + "ipv6Address": [ # Output only. IPv6 addresses assigned to this network, if any. Each address is a string in standard IPv6 text representation (e.g., "2001:db8::1"). + "A String", + ], "lanIpAddress": "A String", # Output only. LAN IP address. + "linkDownSpeedKbps": "A String", # Output only. The maximum downstream bandwidth in Kilobits per second (Kbps), if reported by the network interface or connection. + "metered": True or False, # Output only. Whether the network was detected as metered. "receivingBitRateMbps": "A String", # Output only. Receiving bit rate measured in Megabits per second. "reportTime": "A String", # Output only. Time at which the network state was reported. "sampleFrequency": "A String", # Output only. Frequency the report is sampled. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html index 96d5f6d4d0..48eff48cb1 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html @@ -135,6 +135,18 @@

Method Details

"orgUnitId": "A String", # Output only. Organization unit ID of the device. }, "eventType": "A String", # The event type of the current event. + "externalDisplaysEvent": { # External display connected/disconnected event payload. # Output only. Payload for external display connected/disconnected event. Present only when `event_type` is `EXTERNAL_DISPLAY_CONNECTED` or `EXTERNAL_DISPLAY_DISCONNECTED`. + "externalDisplayData": [ # List of external displays that were connected/disconnected. + { # External display data. + "displayName": "A String", # The display name. + "edidVersion": "A String", # The EDID version. + "refreshRate": "A String", # The refresh rate. + "resolutionHorizontal": 42, # The horizontal resolution. + "resolutionVertical": 42, # The vertical resolution. + "serialNumber": 42, # The serial number. + }, + ], + }, "httpsLatencyChangeEvent": { # Https latency routine is run periodically and `TelemetryHttpsLatencyChangeEvent` is triggered if a latency problem was detected or if the device has recovered from a latency problem. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`. "httpsLatencyRoutineData": { # Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites. # HTTPS latency routine data that triggered the event. "latency": "A String", # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY. diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html index 18396c5cc6..3b1f8ec434 100644 --- a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html @@ -138,7 +138,7 @@

Method Details

name: string, Required. The name of the account to retrieve. (required) view: string, Optional. What information to include in the response. Allowed values - ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. For `GetAccount`, it defaults to the FULL view. For `ListAccounts`, it only supports BASIC view. + ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. For `GetAccount` and `ListAccounts`, they default to the BASIC view. For `ListAccounts`, it only supports the BASIC view. ACCOUNT_VIEW_BASIC - Include base account information. This is the default view. All fields from Account are included except for the reseller_parent_billing_account field. ACCOUNT_VIEW_FULL - Includes all available account information, inclusive of the accounts reseller_parent_billing_account, if it's a resold account. x__xgafv: string, V1 error format. diff --git a/docs/dyn/compute_beta.reservationBlocks.html b/docs/dyn/compute_beta.reservationBlocks.html index eb3354fc25..f23e575441 100644 --- a/docs/dyn/compute_beta.reservationBlocks.html +++ b/docs/dyn/compute_beta.reservationBlocks.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)

Retrieves information about the specified reservation block.

+

+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation blocks under a single reservation.

@@ -89,6 +92,12 @@

Instance Methods

performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)

Allows customers to perform maintenance on a reservation block

+

+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

Method Details

close() @@ -198,6 +207,376 @@

Method Details

}
+
+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation blocks under a single reservation.
@@ -717,4 +1096,915 @@ 

Method Details

}
+
+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_beta.reservationSubBlocks.html b/docs/dyn/compute_beta.reservationSubBlocks.html index 6783745b1a..56d7082195 100644 --- a/docs/dyn/compute_beta.reservationSubBlocks.html +++ b/docs/dyn/compute_beta.reservationSubBlocks.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, parentName, reservationSubBlock, x__xgafv=None)

Retrieves information about the specified reservation subBlock.

+

+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation subBlocks under a single reservation.

@@ -92,6 +95,12 @@

Instance Methods

reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

Allows customers to report a faulty subBlock.

+

+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

Method Details

close() @@ -186,6 +195,376 @@

Method Details

}
+
+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation subBlocks under a single reservation.
@@ -987,4 +1366,915 @@ 

Method Details

}
+
+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_v1.reservationBlocks.html b/docs/dyn/compute_v1.reservationBlocks.html index d214e38ffc..eec1bd0208 100644 --- a/docs/dyn/compute_v1.reservationBlocks.html +++ b/docs/dyn/compute_v1.reservationBlocks.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)

Retrieves information about the specified reservation block.

+

+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation blocks under a single reservation.

@@ -89,6 +92,12 @@

Instance Methods

performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)

Allows customers to perform maintenance on a reservation block

+

+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

Method Details

close() @@ -196,6 +205,376 @@

Method Details

}
+
+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation blocks under a single reservation.
@@ -713,4 +1092,915 @@ 

Method Details

}
+
+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_v1.reservationSubBlocks.html b/docs/dyn/compute_v1.reservationSubBlocks.html index 8e5551c495..24d744ca4c 100644 --- a/docs/dyn/compute_v1.reservationSubBlocks.html +++ b/docs/dyn/compute_v1.reservationSubBlocks.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, parentName, reservationSubBlock, x__xgafv=None)

Retrieves information about the specified reservation subBlock.

+

+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. May be empty if no such

list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation subBlocks under a single reservation.

@@ -92,6 +95,12 @@

Instance Methods

reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

Allows customers to report a faulty subBlock.

+

+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource.

+

+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

Method Details

close() @@ -184,6 +193,376 @@

Method Details

}
+
+ getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation subBlocks under a single reservation.
@@ -983,4 +1362,915 @@ 

Method Details

}
+
+ setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+      # Deprecated. Use 'policy' to specify bindings.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+      # Deprecated. Use 'policy' to specify the etag.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+      # the policy is limited to a few 10s of KB. An empty policy is in general a
+      # valid policy but certain services (like Projects) might reject them.
+      # controls for Google Cloud resources.
+      #
+      #
+      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+      # `members`, or principals, to a single `role`. Principals can be user
+      # accounts, service accounts, Google groups, and domains (such as G Suite). A
+      # `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role.
+      #
+      # For some types of Google Cloud resources, a `binding` can also specify a
+      # `condition`, which is a logical expression that allows access to a resource
+      # only if the expression evaluates to `true`. A condition can add constraints
+      # based on attributes of the request, the resource, or both. To learn which
+      # resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      #
+      # **JSON example:**
+      #
+      # ```
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": [
+      #             "user:eve@example.com"
+      #           ],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ],
+      #       "etag": "BwWWja0YfJA=",
+      #       "version": 3
+      #     }
+      # ```
+      #
+      # **YAML example:**
+      #
+      # ```
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #     etag: BwWWja0YfJA=
+      #     version: 3
+      # ```
+      #
+      # For a description of IAM and its features, see the
+      # [IAM documentation](https://cloud.google.com/iam/docs/).
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service.
+          # The configuration determines which permission types are logged, and what
+          # identities, if any, are exempted from logging.
+          # An AuditConfig must have one or more AuditLogConfigs.
+          #
+          # If there are AuditConfigs for both `allServices` and a specific service,
+          # the union of the two AuditConfigs is used for that service: the log_types
+          # specified in each AuditConfig are enabled, and the exempted_members in each
+          # AuditLogConfig are exempted.
+          #
+          # Example Policy with multiple AuditConfigs:
+          #
+          #     {
+          #       "audit_configs": [
+          #         {
+          #           "service": "allServices",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ",
+          #               "exempted_members": [
+          #                 "user:jose@example.com"
+          #               ]
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE"
+          #             },
+          #             {
+          #               "log_type": "ADMIN_READ"
+          #             }
+          #           ]
+          #         },
+          #         {
+          #           "service": "sampleservice.googleapis.com",
+          #           "audit_log_configs": [
+          #             {
+          #               "log_type": "DATA_READ"
+          #             },
+          #             {
+          #               "log_type": "DATA_WRITE",
+          #               "exempted_members": [
+          #                 "user:aliya@example.com"
+          #               ]
+          #             }
+          #           ]
+          #         }
+          #       ]
+          #     }
+          #
+          # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+          # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+          # `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions.
+              # Example:
+              #
+              #     {
+              #       "audit_log_configs": [
+              #         {
+              #           "log_type": "DATA_READ",
+              #           "exempted_members": [
+              #             "user:jose@example.com"
+              #           ]
+              #         },
+              #         {
+              #           "log_type": "DATA_WRITE"
+              #         }
+              #       ]
+              #     }
+              #
+              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+              # jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+                # permission.
+                # Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging.
+            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+            # `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+        # may specify a `condition` that determines how and when the `bindings` are
+        # applied. Each of the `bindings` must contain at least one principal.
+        #
+        # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+        # of these principals can be Google groups. Each occurrence of a principal
+        # counts towards these limits. For example, if the `bindings` grant 50
+        # different roles to `user:alice@example.com`, and not to any other
+        # principal, then you can add another 1,450 principals to the `bindings` in
+        # the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+            #
+            # If the condition evaluates to `true`, then this binding applies to the
+            # current request.
+            #
+            # If the condition evaluates to `false`, then this binding does not apply to
+            # the current request. However, a different role binding might grant the same
+            # role to one or more of the principals in this binding.
+            #
+            # To learn which resources support conditions in their IAM policies, see the
+            # [IAM
+            # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+            # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+            # are documented at https://github.com/google/cel-spec.
+            #
+            # Example (Comparison):
+            #
+            #     title: "Summary size limit"
+            #     description: "Determines if a summary is less than 100 chars"
+            #     expression: "document.summary.size() < 100"
+            #
+            # Example (Equality):
+            #
+            #     title: "Requestor is owner"
+            #     description: "Determines if requestor is the document owner"
+            #     expression: "document.owner == request.auth.claims.email"
+            #
+            # Example (Logic):
+            #
+            #     title: "Public documents"
+            #     description: "Determine whether the document should be publicly visible"
+            #     expression: "document.type != 'private' && document.type != 'internal'"
+            #
+            # Example (Data Manipulation):
+            #
+            #     title: "Notification string"
+            #     description: "Create a notification string with a timestamp."
+            #     expression: "'New message received at ' + string(document.create_time)"
+            #
+            # The exact variables and functions that may be referenced within an expression
+            # are determined by the service that evaluates it. See the service
+            # documentation for additional information.
+          "description": "A String", # Optional. Description of the expression. This is a longer text which
+              # describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language
+              # syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error
+              # reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+              # its purpose. This can be used e.g. in UIs which allow to enter the
+              # expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+            # `members` can have the following values:
+            #
+            # * `allUsers`: A special identifier that represents anyone who is
+            #    on the internet; with or without a Google account.
+            #
+            # * `allAuthenticatedUsers`: A special identifier that represents anyone
+            #    who is authenticated with a Google account or a service account.
+            #    Does not include identities that come from external identity providers
+            #    (IdPs) through identity federation.
+            #
+            # * `user:{emailid}`: An email address that represents a specific Google
+            #    account. For example, `alice@example.com` .
+            #
+            #
+            # * `serviceAccount:{emailid}`: An email address that represents a Google
+            #    service account. For example,
+            #    `my-other-app@appspot.gserviceaccount.com`.
+            #
+            # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+            #    identifier for a
+            #    [Kubernetes service
+            #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+            #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+            #
+            # * `group:{emailid}`: An email address that represents a Google group.
+            #    For example, `admins@example.com`.
+            #
+            #
+            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+            #    users of that domain. For example, `google.com` or `example.com`.
+            #
+            #
+            #
+            #
+            # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workforce identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+            #   All workforce identities in a group.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All workforce identities with a specific attribute value.
+            #
+            # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+            #   All identities in a workforce identity pool.
+            #
+            # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+            #   A single identity in a workload identity pool.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+            #   A workload identity pool group.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+            #   All identities in a workload identity pool with a certain attribute.
+            #
+            # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+            #   All identities in a workload identity pool.
+            #
+            # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a user that has been recently deleted. For
+            #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+            #    recovered, this value reverts to `user:{emailid}` and the recovered user
+            #    retains the role in the binding.
+            #
+            # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+            #    unique identifier) representing a service account that has been recently
+            #    deleted. For example,
+            #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+            #    If the service account is undeleted, this value reverts to
+            #    `serviceAccount:{emailid}` and the undeleted service account retains the
+            #    role in the binding.
+            #
+            # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+            #    identifier) representing a Google group that has been recently
+            #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+            #    the group is recovered, this value reverts to `group:{emailid}` and the
+            #    recovered group retains the role in the binding.
+            #
+            # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+            #   Deleted single identity in a workforce identity pool. For example,
+            #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals.
+            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+            #
+            # For an overview of the IAM roles and permissions, see the
+            # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+            # a list of the available pre-defined roles, see
+            # [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+        # prevent simultaneous updates of a policy from overwriting each other.
+        # It is strongly suggested that systems make use of the `etag` in the
+        # read-modify-write cycle to perform policy updates in order to avoid race
+        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+        # systems are expected to put that etag in the request to `setIamPolicy` to
+        # ensure that their change will be applied to the same version of the policy.
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy.
+        #
+        # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+        # are rejected.
+        #
+        # Any operation that affects conditional role bindings must specify version
+        # `3`. This requirement applies to the following operations:
+        #
+        # * Getting a policy that includes a conditional role binding
+        # * Adding a conditional role binding to a policy
+        # * Changing a conditional role binding in a policy
+        # * Removing any role binding, with or without a condition, from a policy
+        #   that includes conditions
+        #
+        # **Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+        # you to overwrite a version `3` policy with a version `1` policy, and all of
+        # the conditions in the version `3` policy are lost.
+        #
+        # If a policy does not include any conditions, operations on that policy may
+        # specify any valid version or leave the field unset.
+        #
+        # To learn which resources support conditions in their IAM policies, see the
+        # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access
+    # controls for Google Cloud resources.
+    #
+    #
+    # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+    # `members`, or principals, to a single `role`. Principals can be user
+    # accounts, service accounts, Google groups, and domains (such as G Suite). A
+    # `role` is a named list of permissions; each `role` can be an IAM predefined
+    # role or a user-created custom role.
+    #
+    # For some types of Google Cloud resources, a `binding` can also specify a
+    # `condition`, which is a logical expression that allows access to a resource
+    # only if the expression evaluates to `true`. A condition can add constraints
+    # based on attributes of the request, the resource, or both. To learn which
+    # resources support conditions in their IAM policies, see the
+    # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+    #
+    # **JSON example:**
+    #
+    # ```
+    #     {
+    #       "bindings": [
+    #         {
+    #           "role": "roles/resourcemanager.organizationAdmin",
+    #           "members": [
+    #             "user:mike@example.com",
+    #             "group:admins@example.com",
+    #             "domain:google.com",
+    #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+    #           ]
+    #         },
+    #         {
+    #           "role": "roles/resourcemanager.organizationViewer",
+    #           "members": [
+    #             "user:eve@example.com"
+    #           ],
+    #           "condition": {
+    #             "title": "expirable access",
+    #             "description": "Does not grant access after Sep 2020",
+    #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+    #           }
+    #         }
+    #       ],
+    #       "etag": "BwWWja0YfJA=",
+    #       "version": 3
+    #     }
+    # ```
+    #
+    # **YAML example:**
+    #
+    # ```
+    #     bindings:
+    #     - members:
+    #       - user:mike@example.com
+    #       - group:admins@example.com
+    #       - domain:google.com
+    #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+    #       role: roles/resourcemanager.organizationAdmin
+    #     - members:
+    #       - user:eve@example.com
+    #       role: roles/resourcemanager.organizationViewer
+    #       condition:
+    #         title: expirable access
+    #         description: Does not grant access after Sep 2020
+    #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+    #     etag: BwWWja0YfJA=
+    #     version: 3
+    # ```
+    #
+    # For a description of IAM and its features, see the
+    # [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service.
+        # The configuration determines which permission types are logged, and what
+        # identities, if any, are exempted from logging.
+        # An AuditConfig must have one or more AuditLogConfigs.
+        #
+        # If there are AuditConfigs for both `allServices` and a specific service,
+        # the union of the two AuditConfigs is used for that service: the log_types
+        # specified in each AuditConfig are enabled, and the exempted_members in each
+        # AuditLogConfig are exempted.
+        #
+        # Example Policy with multiple AuditConfigs:
+        #
+        #     {
+        #       "audit_configs": [
+        #         {
+        #           "service": "allServices",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ",
+        #               "exempted_members": [
+        #                 "user:jose@example.com"
+        #               ]
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE"
+        #             },
+        #             {
+        #               "log_type": "ADMIN_READ"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "service": "sampleservice.googleapis.com",
+        #           "audit_log_configs": [
+        #             {
+        #               "log_type": "DATA_READ"
+        #             },
+        #             {
+        #               "log_type": "DATA_WRITE",
+        #               "exempted_members": [
+        #                 "user:aliya@example.com"
+        #               ]
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     }
+        #
+        # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+        # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+        # `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions.
+            # Example:
+            #
+            #     {
+            #       "audit_log_configs": [
+            #         {
+            #           "log_type": "DATA_READ",
+            #           "exempted_members": [
+            #             "user:jose@example.com"
+            #           ]
+            #         },
+            #         {
+            #           "log_type": "DATA_WRITE"
+            #         }
+            #       ]
+            #     }
+            #
+            # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+            # jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+              # permission.
+              # Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging.
+          # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+          # `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+      # may specify a `condition` that determines how and when the `bindings` are
+      # applied. Each of the `bindings` must contain at least one principal.
+      #
+      # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+      # of these principals can be Google groups. Each occurrence of a principal
+      # counts towards these limits. For example, if the `bindings` grant 50
+      # different roles to `user:alice@example.com`, and not to any other
+      # principal, then you can add another 1,450 principals to the `bindings` in
+      # the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+          #
+          # If the condition evaluates to `true`, then this binding applies to the
+          # current request.
+          #
+          # If the condition evaluates to `false`, then this binding does not apply to
+          # the current request. However, a different role binding might grant the same
+          # role to one or more of the principals in this binding.
+          #
+          # To learn which resources support conditions in their IAM policies, see the
+          # [IAM
+          # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+          # are documented at https://github.com/google/cel-spec.
+          #
+          # Example (Comparison):
+          #
+          #     title: "Summary size limit"
+          #     description: "Determines if a summary is less than 100 chars"
+          #     expression: "document.summary.size() < 100"
+          #
+          # Example (Equality):
+          #
+          #     title: "Requestor is owner"
+          #     description: "Determines if requestor is the document owner"
+          #     expression: "document.owner == request.auth.claims.email"
+          #
+          # Example (Logic):
+          #
+          #     title: "Public documents"
+          #     description: "Determine whether the document should be publicly visible"
+          #     expression: "document.type != 'private' && document.type != 'internal'"
+          #
+          # Example (Data Manipulation):
+          #
+          #     title: "Notification string"
+          #     description: "Create a notification string with a timestamp."
+          #     expression: "'New message received at ' + string(document.create_time)"
+          #
+          # The exact variables and functions that may be referenced within an expression
+          # are determined by the service that evaluates it. See the service
+          # documentation for additional information.
+        "description": "A String", # Optional. Description of the expression. This is a longer text which
+            # describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language
+            # syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error
+            # reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+            # its purpose. This can be used e.g. in UIs which allow to enter the
+            # expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+          # `members` can have the following values:
+          #
+          # * `allUsers`: A special identifier that represents anyone who is
+          #    on the internet; with or without a Google account.
+          #
+          # * `allAuthenticatedUsers`: A special identifier that represents anyone
+          #    who is authenticated with a Google account or a service account.
+          #    Does not include identities that come from external identity providers
+          #    (IdPs) through identity federation.
+          #
+          # * `user:{emailid}`: An email address that represents a specific Google
+          #    account. For example, `alice@example.com` .
+          #
+          #
+          # * `serviceAccount:{emailid}`: An email address that represents a Google
+          #    service account. For example,
+          #    `my-other-app@appspot.gserviceaccount.com`.
+          #
+          # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+          #    identifier for a
+          #    [Kubernetes service
+          #    account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+          #    For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+          #
+          # * `group:{emailid}`: An email address that represents a Google group.
+          #    For example, `admins@example.com`.
+          #
+          #
+          # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+          #    users of that domain. For example, `google.com` or `example.com`.
+          #
+          #
+          #
+          #
+          # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workforce identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+          #   All workforce identities in a group.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All workforce identities with a specific attribute value.
+          #
+          # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+          #   All identities in a workforce identity pool.
+          #
+          # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+          #   A single identity in a workload identity pool.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+          #   A workload identity pool group.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+          #   All identities in a workload identity pool with a certain attribute.
+          #
+          # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+          #   All identities in a workload identity pool.
+          #
+          # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a user that has been recently deleted. For
+          #    example, `alice@example.com?uid=123456789012345678901`. If the user is
+          #    recovered, this value reverts to `user:{emailid}` and the recovered user
+          #    retains the role in the binding.
+          #
+          # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+          #    unique identifier) representing a service account that has been recently
+          #    deleted. For example,
+          #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+          #    If the service account is undeleted, this value reverts to
+          #    `serviceAccount:{emailid}` and the undeleted service account retains the
+          #    role in the binding.
+          #
+          # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+          #    identifier) representing a Google group that has been recently
+          #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+          #    the group is recovered, this value reverts to `group:{emailid}` and the
+          #    recovered group retains the role in the binding.
+          #
+          # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+          #   Deleted single identity in a workforce identity pool. For example,
+          #   `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals.
+          # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+          #
+          # For an overview of the IAM roles and permissions, see the
+          # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+          # a list of the available pre-defined roles, see
+          # [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+      # prevent simultaneous updates of a policy from overwriting each other.
+      # It is strongly suggested that systems make use of the `etag` in the
+      # read-modify-write cycle to perform policy updates in order to avoid race
+      # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      # systems are expected to put that etag in the request to `setIamPolicy` to
+      # ensure that their change will be applied to the same version of the policy.
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy.
+      #
+      # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+      # are rejected.
+      #
+      # Any operation that affects conditional role bindings must specify version
+      # `3`. This requirement applies to the following operations:
+      #
+      # * Getting a policy that includes a conditional role binding
+      # * Adding a conditional role binding to a policy
+      # * Changing a conditional role binding in a policy
+      # * Removing any role binding, with or without a condition, from a policy
+      #   that includes conditions
+      #
+      # **Important:** If you use IAM Conditions, you must include the `etag` field
+      # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+      # you to overwrite a version `3` policy with a version `1` policy, and all of
+      # the conditions in the version `3` policy are lost.
+      #
+      # If a policy does not include any conditions, operations on that policy may
+      # specify any valid version or leave the field unset.
+      #
+      # To learn which resources support conditions in their IAM policies, see the
+      # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  parentResource: string, Name or id of parent resource of the resource for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 89924200c0..c7cd2c4d55 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -736,6 +736,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -763,7 +766,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -932,7 +935,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -997,6 +1000,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -1013,7 +1019,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1128,6 +1134,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1155,7 +1164,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2147,6 +2156,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2174,7 +2186,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2343,7 +2355,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2408,6 +2420,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -2424,7 +2439,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2539,6 +2554,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2566,7 +2584,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3422,6 +3440,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3449,7 +3470,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3618,7 +3639,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3683,6 +3704,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -3699,7 +3723,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3814,6 +3838,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3841,7 +3868,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5255,6 +5282,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. @@ -5406,7 +5436,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5456,7 +5486,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 0fdc5629ec..b2ba87c2f8 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -220,6 +220,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -247,7 +250,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -749,6 +752,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -776,7 +782,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1105,6 +1111,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1132,7 +1141,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1755,6 +1764,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": "A String", # Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size. "diskType": "A String", # Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type. @@ -1777,7 +1789,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index c6011ddc99..4925c2057b 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -834,6 +834,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -861,7 +864,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1030,7 +1033,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1095,6 +1098,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -1111,7 +1117,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1226,6 +1232,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1253,7 +1262,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2245,6 +2254,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2272,7 +2284,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2441,7 +2453,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2506,6 +2518,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -2522,7 +2537,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2637,6 +2652,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2664,7 +2682,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3564,6 +3582,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3591,7 +3612,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3760,7 +3781,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3825,6 +3846,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -3841,7 +3865,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3956,6 +3980,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3983,7 +4010,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5282,6 +5309,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. @@ -5433,7 +5463,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5483,7 +5513,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index f9e49250a1..ddd11a65bd 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -285,6 +285,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -312,7 +315,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -814,6 +817,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -841,7 +847,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1170,6 +1176,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1197,7 +1206,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1745,6 +1754,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": "A String", # Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size. "diskType": "A String", # Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type. @@ -1767,7 +1779,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index ecdb88346a..d3085fd7e8 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -759,6 +759,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -797,7 +800,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -968,7 +971,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1033,6 +1036,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -1057,7 +1063,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1173,6 +1179,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1211,7 +1220,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1524,6 +1533,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -2252,6 +2268,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2290,7 +2309,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2461,7 +2480,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2526,6 +2545,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -2550,7 +2572,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2666,6 +2688,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2704,7 +2729,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3017,6 +3042,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -3609,6 +3641,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3647,7 +3682,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3818,7 +3853,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3883,6 +3918,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -3907,7 +3945,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -4023,6 +4061,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -4061,7 +4102,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -4374,6 +4415,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -5523,6 +5571,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. @@ -5684,7 +5735,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5734,7 +5785,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 4e0f0bb345..e0952ffb40 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -221,6 +221,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -259,7 +262,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -765,6 +768,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -803,7 +809,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1136,6 +1142,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1174,7 +1183,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1801,6 +1810,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": "A String", # Optional. The desired disk size for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size. "diskType": "A String", # Optional. The desired disk type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type. @@ -1823,7 +1835,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 6b5d3e38a3..d6c82e5b8d 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -864,6 +864,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -902,7 +905,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1073,7 +1076,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1138,6 +1141,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -1162,7 +1168,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1278,6 +1284,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1316,7 +1325,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1629,6 +1638,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -2357,6 +2373,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2395,7 +2414,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2566,7 +2585,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2631,6 +2650,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -2655,7 +2677,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -2771,6 +2793,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -2809,7 +2834,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3122,6 +3147,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -3758,6 +3790,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -3796,7 +3831,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -3967,7 +4002,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -4032,6 +4067,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. @@ -4056,7 +4094,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -4172,6 +4210,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -4210,7 +4251,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -4523,6 +4564,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "secretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -5550,6 +5598,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. @@ -5711,7 +5762,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -5761,7 +5812,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 50405bb9df..b6dfdd63ac 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -286,6 +286,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -324,7 +327,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -830,6 +833,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -868,7 +874,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1201,6 +1207,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' @@ -1239,7 +1248,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. @@ -1791,6 +1800,9 @@

Method Details

], "enabled": True or False, # Private registry access is enabled. }, + "writableCgroups": { # Defines writable cgroups configuration. # Optional. WritableCgroups defines writable cgroups configuration for the node pool. + "enabled": True or False, # Optional. Whether writable cgroups is enabled. + }, }, "diskSizeGb": "A String", # Optional. The desired disk size for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size. "diskType": "A String", # Optional. The desired disk type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type. @@ -1813,7 +1825,7 @@

Method Details

"containerLogMaxFiles": 42, # Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. "containerLogMaxSize": "A String", # Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. - "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. + "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive. "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. "evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. "evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure. diff --git a/docs/dyn/dataform_v1.html b/docs/dyn/dataform_v1.html new file mode 100644 index 0000000000..fe0ba7e406 --- /dev/null +++ b/docs/dyn/dataform_v1.html @@ -0,0 +1,111 @@ + + + +

Dataform API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.html b/docs/dyn/dataform_v1.projects.html new file mode 100644 index 0000000000..ea9a1aa4ea --- /dev/null +++ b/docs/dyn/dataform_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Dataform API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.folders.html b/docs/dyn/dataform_v1.projects.locations.folders.html new file mode 100644 index 0000000000..9136452db2 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.folders.html @@ -0,0 +1,218 @@ + + + +

Dataform API . projects . locations . folders

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html new file mode 100644 index 0000000000..ae7d16d9d6 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.html @@ -0,0 +1,250 @@ + + + +

Dataform API . projects . locations

+

Instance Methods

+

+ folders() +

+

Returns the folders Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ repositories() +

+

Returns the repositories Resource.

+ +

+ teamFolders() +

+

Returns the teamFolders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

+ getConfig(name, x__xgafv=None)

+

Get default config for a given project and location.

+

+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

+ updateConfig(name, body=None, updateMask=None, x__xgafv=None)

+

Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ getConfig(name, x__xgafv=None) +
Get default config for a given project and location.
+
+Args:
+  name: string, Required. The config name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Config for all repositories in a given project and location.
+  "defaultKmsKeyName": "A String", # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The config name.
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ updateConfig(name, body=None, updateMask=None, x__xgafv=None) +
Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
+
+Args:
+  name: string, Identifier. The config name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Config for all repositories in a given project and location.
+  "defaultKmsKeyName": "A String", # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The config name.
+}
+
+  updateMask: string, Optional. Specifies the fields to be updated in the config.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Config for all repositories in a given project and location.
+  "defaultKmsKeyName": "A String", # Optional. The default KMS key that is used if no encryption key is provided when a repository is created.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The config name.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.operations.html b/docs/dyn/dataform_v1.projects.locations.operations.html new file mode 100644 index 0000000000..ec9c80bc87 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.operations.html @@ -0,0 +1,239 @@ + + + +

Dataform API . projects . locations . operations

+

Instance Methods

+

+ cancel(name, body=None, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html new file mode 100644 index 0000000000..6b753b90b1 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html @@ -0,0 +1,603 @@ + + + +

Dataform API . projects . locations . repositories . compilationResults

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new CompilationResult in a given project and location.

+

+ get(name, x__xgafv=None)

+

Fetches a single CompilationResult.

+

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

+

Lists CompilationResults in a given Repository.

+

+ list_next()

+

Retrieves the next page of results.

+

+ query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns CompilationResultActions in a given CompilationResult.

+

+ query_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new CompilationResult in a given project and location.
+
+Args:
+  parent: string, Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents the result of compiling a Dataform project.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "compilationErrors": [ # Output only. Errors encountered during project compilation.
+    { # An error encountered when attempting to compile a Dataform project.
+      "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+      "message": "A String", # Output only. The error's top level message.
+      "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+      "stack": "A String", # Output only. The error's full stack trace.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp of when the compilation result was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+  "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Output only. The compilation result's name.
+  "releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+  "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the result of compiling a Dataform project.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "compilationErrors": [ # Output only. Errors encountered during project compilation.
+    { # An error encountered when attempting to compile a Dataform project.
+      "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+      "message": "A String", # Output only. The error's top level message.
+      "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+      "stack": "A String", # Output only. The error's full stack trace.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp of when the compilation result was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+  "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Output only. The compilation result's name.
+  "releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+  "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Fetches a single CompilationResult.
+
+Args:
+  name: string, Required. The compilation result's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the result of compiling a Dataform project.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "compilationErrors": [ # Output only. Errors encountered during project compilation.
+    { # An error encountered when attempting to compile a Dataform project.
+      "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+      "message": "A String", # Output only. The error's top level message.
+      "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+      "stack": "A String", # Output only. The error's full stack trace.
+    },
+  ],
+  "createTime": "A String", # Output only. The timestamp of when the compilation result was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+  "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Output only. The compilation result's name.
+  "releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+  "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists CompilationResults in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  filter: string, Optional. Filter for the returned list.
+  orderBy: string, Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+  pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, 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:
+
+    { # `ListCompilationResults` response message.
+  "compilationResults": [ # List of compilation results.
+    { # Represents the result of compiling a Dataform project.
+      "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+        "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+        "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+        "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+        "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+        "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+        "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+          "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+          "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+        },
+        "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+        "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+        "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+        "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+          "a_key": "A String",
+        },
+      },
+      "compilationErrors": [ # Output only. Errors encountered during project compilation.
+        { # An error encountered when attempting to compile a Dataform project.
+          "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+          "message": "A String", # Output only. The error's top level message.
+          "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+          "stack": "A String", # Output only. The error's full stack trace.
+        },
+      ],
+      "createTime": "A String", # Output only. The timestamp of when the compilation result was created.
+      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+        "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+      },
+      "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+      "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "name": "A String", # Output only. The compilation result's name.
+      "releaseConfig": "A String", # Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+      "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+      "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+    },
+  ],
+  "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.
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns CompilationResultActions in a given CompilationResult.
+
+Args:
+  name: string, Required. The compilation result's name. (required)
+  filter: string, Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
+  pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, 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:
+
+    { # `QueryCompilationResultActions` response message.
+  "compilationResultActions": [ # List of compilation result actions.
+    { # Represents a single Dataform action in a compilation result.
+      "assertion": { # Represents an assertion upon a SQL query which is required return zero rows. # The assertion executed by this action.
+        "dependencyTargets": [ # A list of actions that this action depends on.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+        "parentAction": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The parent action of this assertion. Only set if this assertion was automatically generated.
+          "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+          "name": "A String", # Optional. The action's name, within `database` and `schema`.
+          "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+        },
+        "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the assertion's automatically-generated view and its columns.
+          "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+            "a_key": "A String",
+          },
+          "columns": [ # A list of descriptions of columns within the relation.
+            { # Describes a column.
+              "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+                "A String",
+              ],
+              "description": "A String", # A textual description of the column.
+              "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+                "A String",
+              ],
+            },
+          ],
+          "description": "A String", # A text description of the relation.
+        },
+        "selectQuery": "A String", # The SELECT query which must return zero rows in order for this assertion to succeed.
+        "tags": [ # Arbitrary, user-defined tags on this action.
+          "A String",
+        ],
+      },
+      "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+      "dataPreparation": { # Defines a compiled Data Preparation entity # The data preparation executed by this action.
+        "contentsSql": { # Definition of a SQL Data Preparation # SQL definition for a Data Preparation. Contains a SQL query and additional context information.
+          "errorTable": { # Error table information, used to write error data into a BigQuery table. # Error table configuration,
+            "retentionDays": 42, # Error table partition expiration in days. Only positive values are allowed.
+            "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Error Table target.
+              "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+              "name": "A String", # Optional. The action's name, within `database` and `schema`.
+              "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+            },
+          },
+          "load": { # Simplified load configuration for actions # Load configuration.
+            "append": { # Simple load definition # Append into destination table
+            },
+            "maximum": { # Load definition for incremental load modes # Insert records where the value exceeds the previous maximum value for a column in the destination table
+              "column": "A String", # Column name for incremental load modes
+            },
+            "replace": { # Simple load definition # Replace destination table
+            },
+            "unique": { # Load definition for incremental load modes # Insert records where the value of a column is not already present in the destination table
+              "column": "A String", # Column name for incremental load modes
+            },
+          },
+          "query": "A String", # The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.
+        },
+        "contentsYaml": "A String", # The data preparation definition, stored as a YAML string.
+        "dependencyTargets": [ # A list of actions that this action depends on.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+        "tags": [ # Arbitrary, user-defined tags on this action.
+          "A String",
+        ],
+      },
+      "declaration": { # Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. # The declaration declared by this action.
+        "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata.
+          "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+            "a_key": "A String",
+          },
+          "columns": [ # A list of descriptions of columns within the relation.
+            { # Describes a column.
+              "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+                "A String",
+              ],
+              "description": "A String", # A textual description of the column.
+              "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+                "A String",
+              ],
+            },
+          ],
+          "description": "A String", # A text description of the relation.
+        },
+      },
+      "filePath": "A String", # The full path including filename in which this action is located, relative to the workspace root.
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "notebook": { # Represents a notebook. # The notebook executed by this action.
+        "contents": "A String", # The contents of the notebook.
+        "dependencyTargets": [ # A list of actions that this action depends on.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+        "tags": [ # Arbitrary, user-defined tags on this action.
+          "A String",
+        ],
+      },
+      "operations": { # Represents a list of arbitrary database operations. # The database operations executed by this action.
+        "dependencyTargets": [ # A list of actions that this action depends on.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+        "hasOutput": True or False, # Whether these operations produce an output relation.
+        "queries": [ # A list of arbitrary SQL statements that will be executed without alteration.
+          "A String",
+        ],
+        "relationDescriptor": { # Describes a relation and its columns. # Descriptor for any output relation and its columns. Only set if `has_output` is true.
+          "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+            "a_key": "A String",
+          },
+          "columns": [ # A list of descriptions of columns within the relation.
+            { # Describes a column.
+              "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+                "A String",
+              ],
+              "description": "A String", # A textual description of the column.
+              "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+                "A String",
+              ],
+            },
+          ],
+          "description": "A String", # A text description of the relation.
+        },
+        "tags": [ # Arbitrary, user-defined tags on this action.
+          "A String",
+        ],
+      },
+      "relation": { # Represents a database relation. # The database relation created/updated by this action.
+        "additionalOptions": { # Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.
+          "a_key": "A String",
+        },
+        "clusterExpressions": [ # A list of columns or SQL expressions used to cluster the table.
+          "A String",
+        ],
+        "dependencyTargets": [ # A list of actions that this action depends on.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+        "incrementalTableConfig": { # Contains settings for relations of type `INCREMENTAL_TABLE`. # Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`.
+          "incrementalPostOperations": [ # SQL statements to be executed after inserting new rows into the relation.
+            "A String",
+          ],
+          "incrementalPreOperations": [ # SQL statements to be executed before inserting new rows into the relation.
+            "A String",
+          ],
+          "incrementalSelectQuery": "A String", # The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed.
+          "refreshDisabled": True or False, # Whether this table should be protected from being refreshed.
+          "uniqueKeyParts": [ # A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation.
+            "A String",
+          ],
+          "updatePartitionFilter": "A String", # A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information).
+        },
+        "partitionExpirationDays": 42, # Sets the partition expiration in days.
+        "partitionExpression": "A String", # The SQL expression used to partition the relation.
+        "postOperations": [ # SQL statements to be executed after creating the relation.
+          "A String",
+        ],
+        "preOperations": [ # SQL statements to be executed before creating the relation.
+          "A String",
+        ],
+        "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns.
+          "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+            "a_key": "A String",
+          },
+          "columns": [ # A list of descriptions of columns within the relation.
+            { # Describes a column.
+              "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+                "A String",
+              ],
+              "description": "A String", # A textual description of the column.
+              "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+                "A String",
+              ],
+            },
+          ],
+          "description": "A String", # A text description of the relation.
+        },
+        "relationType": "A String", # The type of this relation.
+        "requirePartitionFilter": True or False, # Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.
+        "selectQuery": "A String", # The SELECT query which returns rows which this relation should contain.
+        "tags": [ # Arbitrary, user-defined tags on this action.
+          "A String",
+        ],
+      },
+      "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # This action's identifier. Unique within the compilation result.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    },
+  ],
+  "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.
+}
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.html b/docs/dyn/dataform_v1.projects.locations.repositories.html new file mode 100644 index 0000000000..9fcc309819 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.html @@ -0,0 +1,782 @@ + + + +

Dataform API . projects . locations . repositories

+

Instance Methods

+

+ compilationResults() +

+

Returns the compilationResults Resource.

+ +

+ releaseConfigs() +

+

Returns the releaseConfigs Resource.

+ +

+ workflowConfigs() +

+

Returns the workflowConfigs Resource.

+ +

+ workflowInvocations() +

+

Returns the workflowInvocations Resource.

+ +

+ workspaces() +

+

Returns the workspaces Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ commit(name, body=None, x__xgafv=None)

+

Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.

+

+ computeAccessTokenStatus(name, x__xgafv=None)

+

Computes a Repository's Git access token status.

+

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

+

Creates a new Repository in a given project and location.

+

+ delete(name, force=None, x__xgafv=None)

+

Deletes a single Repository.

+

+ fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)

+

Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.

+

+ fetchHistory_next()

+

Retrieves the next page of results.

+

+ fetchRemoteBranches(name, x__xgafv=None)

+

Fetches a Repository's remote branches.

+

+ get(name, x__xgafv=None)

+

Fetches a single Repository.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

+

+ queryDirectoryContents(name, commitSha=None, pageSize=None, pageToken=None, path=None, x__xgafv=None)

+

Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.

+

+ queryDirectoryContents_next()

+

Retrieves the next page of results.

+

+ readFile(name, commitSha=None, path=None, x__xgafv=None)

+

Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ commit(name, body=None, x__xgafv=None) +
Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `CommitRepositoryChanges` request message.
+  "commitMetadata": { # Represents a Dataform Git commit. # Required. The changes to commit to the repository.
+    "author": { # Represents the author of a Git commit. # Required. The commit's author.
+      "emailAddress": "A String", # Required. The commit author's email address.
+      "name": "A String", # Required. The commit author's name.
+    },
+    "commitMessage": "A String", # Optional. The commit's message.
+  },
+  "fileOperations": { # Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.
+    "a_key": { # Represents a single file operation to the repository.
+      "deleteFile": { # Represents the delete file operation. # Represents the delete operation.
+      },
+      "writeFile": { # Represents the write file operation (for files added or modified). # Represents the write operation.
+        "contents": "A String", # The file's contents.
+      },
+    },
+  },
+  "requiredHeadCommitSha": "A String", # Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `CommitRepositoryChanges` response message.
+  "commitSha": "A String", # The commit SHA of the current commit.
+}
+
+ +
+ computeAccessTokenStatus(name, x__xgafv=None) +
Computes a Repository's Git access token status.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `ComputeRepositoryAccessTokenStatus` response message.
+  "tokenStatus": "A String", # Indicates the status of the Git access token.
+}
+
+ +
+ create(parent, body=None, repositoryId=None, x__xgafv=None) +
Creates a new Repository in a given project and location.
+
+Args:
+  parent: string, Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform Git repository.
+  "createTime": "A String", # Output only. The timestamp of when the repository was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "displayName": "A String", # Optional. The repository's user-friendly name.
+  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    "defaultBranch": "A String", # Required. The Git remote's default branch name.
+    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    },
+    "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+    "url": "A String", # Required. The Git remote's URL.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+  "labels": { # Optional. Repository user labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The repository's name.
+  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+  "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+  },
+}
+
+  repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform Git repository.
+  "createTime": "A String", # Output only. The timestamp of when the repository was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "displayName": "A String", # Optional. The repository's user-friendly name.
+  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    "defaultBranch": "A String", # Required. The Git remote's default branch name.
+    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    },
+    "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+    "url": "A String", # Required. The Git remote's URL.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+  "labels": { # Optional. Repository user labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The repository's name.
+  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+  "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+  },
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a single Repository.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  force: boolean, Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.
+  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); }
+}
+
+ +
+ fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None) +
Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  pageSize: integer, Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, 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:
+
+    { # `FetchRepositoryHistory` response message.
+  "commits": [ # A list of commit logs, ordered by 'git log' default order.
+    { # Represents a single commit log.
+      "author": { # Represents the author of a Git commit. # The commit author for this commit log entry.
+        "emailAddress": "A String", # Required. The commit author's email address.
+        "name": "A String", # Required. The commit author's name.
+      },
+      "commitMessage": "A String", # The commit message for this commit log entry.
+      "commitSha": "A String", # The commit SHA for this commit log entry.
+      "commitTime": "A String", # Commit timestamp.
+    },
+  ],
+  "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.
+}
+
+ +
+ fetchHistory_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.
+        
+
+ +
+ fetchRemoteBranches(name, x__xgafv=None) +
Fetches a Repository's remote branches.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `FetchRemoteBranches` response message.
+  "branches": [ # The remote repository's branch names.
+    "A String",
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) +
Fetches a single Repository.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform Git repository.
+  "createTime": "A String", # Output only. The timestamp of when the repository was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "displayName": "A String", # Optional. The repository's user-friendly name.
+  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    "defaultBranch": "A String", # Required. The Git remote's default branch name.
+    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    },
+    "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+    "url": "A String", # Required. The Git remote's URL.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+  "labels": { # Optional. Repository user labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The repository's name.
+  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+  "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+  },
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
+
+Args:
+  parent: string, Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`. (required)
+  filter: string, Optional. Filter for the returned list.
+  orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+  pageSize: integer, Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, 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:
+
+    { # `ListRepositories` response message.
+  "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.
+  "repositories": [ # List of repositories.
+    { # Represents a Dataform Git repository.
+      "createTime": "A String", # Output only. The timestamp of when the repository was created.
+      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+        "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+      },
+      "displayName": "A String", # Optional. The repository's user-friendly name.
+      "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+        "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+        "defaultBranch": "A String", # Required. The Git remote's default branch name.
+        "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+          "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+          "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+        },
+        "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+        "url": "A String", # Required. The Git remote's URL.
+      },
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+      "labels": { # Optional. Repository user labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The repository's name.
+      "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+      "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+      "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+      "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+        "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+        "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+        "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+      },
+    },
+  ],
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
+
+Args:
+  name: string, Identifier. The repository's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform Git repository.
+  "createTime": "A String", # Output only. The timestamp of when the repository was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "displayName": "A String", # Optional. The repository's user-friendly name.
+  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    "defaultBranch": "A String", # Required. The Git remote's default branch name.
+    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    },
+    "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+    "url": "A String", # Required. The Git remote's URL.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+  "labels": { # Optional. Repository user labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The repository's name.
+  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+  "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+  },
+}
+
+  updateMask: string, Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform Git repository.
+  "createTime": "A String", # Output only. The timestamp of when the repository was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "displayName": "A String", # Optional. The repository's user-friendly name.
+  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    "defaultBranch": "A String", # Required. The Git remote's default branch name.
+    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
+      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
+      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+    },
+    "tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information.
+    "url": "A String", # Required. The Git remote's URL.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
+  "labels": { # Optional. Repository user labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The repository's name.
+  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+  "setAuthenticatedUserAdmin": True or False, # Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+  },
+}
+
+ +
+ queryDirectoryContents(name, commitSha=None, pageSize=None, pageToken=None, path=None, x__xgafv=None) +
Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  commitSha: string, Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
+  pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
+  path: string, Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `QueryRepositoryDirectoryContents` response message.
+  "directoryEntries": [ # List of entries in the directory.
+    { # Represents a single entry in a directory.
+      "directory": "A String", # A child directory in the directory.
+      "file": "A String", # A file in the directory.
+    },
+  ],
+  "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.
+}
+
+ +
+ queryDirectoryContents_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.
+        
+
+ +
+ readFile(name, commitSha=None, path=None, x__xgafv=None) +
Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  commitSha: string, Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
+  path: string, Required. Full file path to read including filename, from repository root.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `ReadRepositoryFile` response message.
+  "contents": "A String", # The file's contents.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.releaseConfigs.html b/docs/dyn/dataform_v1.projects.locations.repositories.releaseConfigs.html new file mode 100644 index 0000000000..fd7df877d2 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.releaseConfigs.html @@ -0,0 +1,466 @@ + + + +

Dataform API . projects . locations . repositories . releaseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new ReleaseConfig in a given Repository.

+

+ delete(name, x__xgafv=None)

+

Deletes a single ReleaseConfig.

+

+ get(name, x__xgafv=None)

+

Fetches a single ReleaseConfig.

+

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

+

Lists ReleaseConfigs in a given Repository.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, releaseConfigId=None, x__xgafv=None) +
Creates a new ReleaseConfig in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform release configuration.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+  "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+  "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The release config's name.
+  "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+    { # A record of an attempt to create a compilation result for this release config.
+      "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+        "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.
+      },
+      "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+    },
+  ],
+  "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+  releaseConfigId: string, Required. The ID to use for the release config, which will become the final component of the release config's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform release configuration.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+  "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+  "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The release config's name.
+  "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+    { # A record of an attempt to create a compilation result for this release config.
+      "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+        "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.
+      },
+      "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+    },
+  ],
+  "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a single ReleaseConfig.
+
+Args:
+  name: string, Required. The release config's name. (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) +
Fetches a single ReleaseConfig.
+
+Args:
+  name: string, Required. The release config's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform release configuration.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+  "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+  "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The release config's name.
+  "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+    { # A record of an attempt to create a compilation result for this release config.
+      "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+        "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.
+      },
+      "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+    },
+  ],
+  "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ReleaseConfigs in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  pageSize: integer, Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, 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:
+
+    { # `ListReleaseConfigs` response message.
+  "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.
+  "releaseConfigs": [ # List of release configs.
+    { # Represents a Dataform release configuration.
+      "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+        "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+        "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+        "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+        "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+        "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+        "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+          "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+          "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+        },
+        "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+        "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+        "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+        "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+          "a_key": "A String",
+        },
+      },
+      "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+      "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+      "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "name": "A String", # Identifier. The release config's name.
+      "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+        { # A record of an attempt to create a compilation result for this release config.
+          "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+          "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+            "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.
+          },
+          "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+        },
+      ],
+      "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+    },
+  ],
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
+
+Args:
+  name: string, Identifier. The release config's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform release configuration.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+  "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+  "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The release config's name.
+  "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+    { # A record of an attempt to create a compilation result for this release config.
+      "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+        "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.
+      },
+      "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+    },
+  ],
+  "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+  updateMask: string, Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform release configuration.
+  "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+    "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+    "builtinAssertionNamePrefix": "A String", # Optional. The prefix to prepend to built-in assertion names.
+    "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+    "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+    "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options.
+      "aiPlatformNotebookRuntimeTemplate": "A String", # Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.
+      "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
+    },
+    "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+    "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+      "a_key": "A String",
+    },
+  },
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+  "disabled": True or False, # Optional. Disables automatic creation of compilation results.
+  "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The release config's name.
+  "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+    { # A record of an attempt to create a compilation result for this release config.
+      "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "errorStatus": { # 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 status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+        "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.
+      },
+      "releaseTime": "A String", # Output only. The timestamp of this release attempt.
+    },
+  ],
+  "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html b/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html new file mode 100644 index 0000000000..565afde996 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html @@ -0,0 +1,472 @@ + + + +

Dataform API . projects . locations . repositories . workflowConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new WorkflowConfig in a given Repository.

+

+ delete(name, x__xgafv=None)

+

Deletes a single WorkflowConfig.

+

+ get(name, x__xgafv=None)

+

Fetches a single WorkflowConfig.

+

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

+

Lists WorkflowConfigs in a given Repository.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, workflowConfigId=None, x__xgafv=None) +
Creates a new WorkflowConfig in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform workflow configuration.
+  "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+  "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "name": "A String", # Identifier. The workflow config's name.
+  "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+    { # A record of an attempt to create a workflow invocation for this workflow config.
+      "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+        "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.
+      },
+      "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+      "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+    },
+  ],
+  "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+  "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+}
+
+  workflowConfigId: string, Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform workflow configuration.
+  "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+  "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "name": "A String", # Identifier. The workflow config's name.
+  "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+    { # A record of an attempt to create a workflow invocation for this workflow config.
+      "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+        "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.
+      },
+      "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+      "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+    },
+  ],
+  "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+  "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a single WorkflowConfig.
+
+Args:
+  name: string, Required. The workflow config's name. (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) +
Fetches a single WorkflowConfig.
+
+Args:
+  name: string, Required. The workflow config's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform workflow configuration.
+  "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+  "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "name": "A String", # Identifier. The workflow config's name.
+  "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+    { # A record of an attempt to create a workflow invocation for this workflow config.
+      "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+        "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.
+      },
+      "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+      "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+    },
+  ],
+  "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+  "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists WorkflowConfigs in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  pageSize: integer, Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, 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:
+
+    { # `ListWorkflowConfigs` response message.
+  "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.
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+  "workflowConfigs": [ # List of workflow configs.
+    { # Represents a Dataform workflow configuration.
+      "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+      "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+      "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+        "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+        "includedTags": [ # Optional. The set of tags to include.
+          "A String",
+        ],
+        "includedTargets": [ # Optional. The set of action identifiers to include.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+        "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+        "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+        "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+      },
+      "name": "A String", # Identifier. The workflow config's name.
+      "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+        { # A record of an attempt to create a workflow invocation for this workflow config.
+          "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+            "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.
+          },
+          "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+          "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+        },
+      ],
+      "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+      "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+      "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
+
+Args:
+  name: string, Identifier. The workflow config's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform workflow configuration.
+  "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+  "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "name": "A String", # Identifier. The workflow config's name.
+  "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+    { # A record of an attempt to create a workflow invocation for this workflow config.
+      "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+        "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.
+      },
+      "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+      "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+    },
+  ],
+  "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+  "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+}
+
+  updateMask: string, Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform workflow configuration.
+  "createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
+  "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+  "disabled": True or False, # Optional. Disables automatic creation of workflow invocations.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "name": "A String", # Identifier. The workflow config's name.
+  "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
+    { # A record of an attempt to create a workflow invocation for this workflow config.
+      "errorStatus": { # 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 status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+        "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.
+      },
+      "executionTime": "A String", # Output only. The timestamp of this execution attempt.
+      "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+    },
+  ],
+  "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+  "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+  "updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html b/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html new file mode 100644 index 0000000000..8db4e70a3d --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html @@ -0,0 +1,450 @@ + + + +

Dataform API . projects . locations . repositories . workflowInvocations

+

Instance Methods

+

+ cancel(name, body=None, x__xgafv=None)

+

Requests cancellation of a running WorkflowInvocation.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new WorkflowInvocation in a given Repository.

+

+ delete(name, x__xgafv=None)

+

Deletes a single WorkflowInvocation.

+

+ get(name, x__xgafv=None)

+

Fetches a single WorkflowInvocation.

+

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

+

Lists WorkflowInvocations in a given Repository.

+

+ list_next()

+

Retrieves the next page of results.

+

+ query(name, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns WorkflowInvocationActions in a given WorkflowInvocation.

+

+ query_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Requests cancellation of a running WorkflowInvocation.
+
+Args:
+  name: string, Required. The workflow invocation resource's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `CancelWorkflowInvocation` request message.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `CancelWorkflowInvocation` response message.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new WorkflowInvocation in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single invocation of a compilation result.
+  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "name": "A String", # Output only. The workflow invocation's name.
+  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "state": "A String", # Output only. This workflow invocation's current state.
+  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single invocation of a compilation result.
+  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "name": "A String", # Output only. The workflow invocation's name.
+  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "state": "A String", # Output only. This workflow invocation's current state.
+  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a single WorkflowInvocation.
+
+Args:
+  name: string, Required. The workflow invocation resource's name. (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) +
Fetches a single WorkflowInvocation.
+
+Args:
+  name: string, Required. The workflow invocation resource's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single invocation of a compilation result.
+  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+    "includedTags": [ # Optional. The set of tags to include.
+      "A String",
+    ],
+    "includedTargets": [ # Optional. The set of action identifiers to include.
+      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    ],
+    "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+  },
+  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "name": "A String", # Output only. The workflow invocation's name.
+  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+  "state": "A String", # Output only. This workflow invocation's current state.
+  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists WorkflowInvocations in a given Repository.
+
+Args:
+  parent: string, Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  filter: string, Optional. Filter for the returned list.
+  orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+  pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, 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:
+
+    { # `ListWorkflowInvocations` response message.
+  "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.
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+  "workflowInvocations": [ # List of workflow invocations.
+    { # Represents a single invocation of a compilation result.
+      "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
+        "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+      },
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+        "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+        "includedTags": [ # Optional. The set of tags to include.
+          "A String",
+        ],
+        "includedTargets": [ # Optional. The set of action identifiers to include.
+          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+            "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+            "name": "A String", # Optional. The action's name, within `database` and `schema`.
+            "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+          },
+        ],
+        "queryPriority": "A String", # Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
+        "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
+        "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+        "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+      },
+      "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+      },
+      "name": "A String", # Output only. The workflow invocation's name.
+      "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+      "state": "A String", # Output only. This workflow invocation's current state.
+      "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ query(name, pageSize=None, pageToken=None, x__xgafv=None) +
Returns WorkflowInvocationActions in a given WorkflowInvocation.
+
+Args:
+  name: string, Required. The workflow invocation's name. (required)
+  pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, 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:
+
+    { # `QueryWorkflowInvocationActions` response message.
+  "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.
+  "workflowInvocationActions": [ # List of workflow invocation actions.
+    { # Represents a single action in a workflow invocation.
+      "bigqueryAction": { # Represents a workflow action that will run against BigQuery. # Output only. The workflow action's bigquery action details.
+        "jobId": "A String", # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
+        "sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed.
+      },
+      "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+      "dataPreparationAction": { # Represents a workflow action that will run a Data Preparation. # Output only. The workflow action's data preparation action details.
+        "contentsSql": { # Definition of a SQL Data Preparation # SQL definition for a Data Preparation. Contains a SQL query and additional context information.
+          "errorTable": { # Error table information, used to write error data into a BigQuery table. # Error table configuration,
+            "retentionDays": 42, # Error table partition expiration in days. Only positive values are allowed.
+            "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Error Table target.
+              "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+              "name": "A String", # Optional. The action's name, within `database` and `schema`.
+              "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+            },
+          },
+          "loadConfig": { # Simplified load configuration for actions # Load configuration.
+            "append": { # Simple load definition # Append into destination table
+            },
+            "maximum": { # Load definition for incremental load modes # Insert records where the value exceeds the previous maximum value for a column in the destination table
+              "column": "A String", # Column name for incremental load modes
+            },
+            "replace": { # Simple load definition # Replace destination table
+            },
+            "unique": { # Load definition for incremental load modes # Insert records where the value of a column is not already present in the destination table
+              "column": "A String", # Column name for incremental load modes
+            },
+          },
+          "query": "A String", # The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.
+        },
+        "contentsYaml": "A String", # Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.
+        "generatedSql": "A String", # Output only. The generated BigQuery SQL script that will be executed. For reference only.
+        "jobId": "A String", # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
+      },
+      "failureReason": "A String", # Output only. If and only if action's state is FAILED a failure reason is set.
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.
+        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+      },
+      "notebookAction": { # Represents a workflow action that will run against a Notebook runtime. # Output only. The workflow action's notebook action details.
+        "contents": "A String", # Output only. The code contents of a Notebook to be run.
+        "jobId": "A String", # Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.
+      },
+      "state": "A String", # Output only. This action's current state.
+      "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. This action's identifier. Unique within the workflow invocation.
+        "database": "A String", # Optional. The action's database (Google Cloud project ID) .
+        "name": "A String", # Optional. The action's name, within `database` and `schema`.
+        "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`.
+      },
+    },
+  ],
+}
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html new file mode 100644 index 0000000000..b2f41ac31e --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html @@ -0,0 +1,884 @@ + + + +

Dataform API . projects . locations . repositories . workspaces

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ commit(name, body=None, x__xgafv=None)

+

Applies a Git commit for uncommitted files in a Workspace.

+

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

+

Creates a new Workspace in a given Repository.

+

+ delete(name, x__xgafv=None)

+

Deletes a single Workspace.

+

+ fetchFileDiff(workspace, path=None, x__xgafv=None)

+

Fetches Git diff for an uncommitted file in a Workspace.

+

+ fetchFileGitStatuses(name, x__xgafv=None)

+

Fetches Git statuses for the files in a Workspace.

+

+ fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None)

+

Fetches Git ahead/behind against a remote branch.

+

+ get(name, x__xgafv=None)

+

Fetches a single Workspace.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ installNpmPackages(workspace, body=None, x__xgafv=None)

+

Installs dependency NPM packages (inside a Workspace).

+

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

+

Lists Workspaces in a given Repository.

+

+ list_next()

+

Retrieves the next page of results.

+

+ makeDirectory(workspace, body=None, x__xgafv=None)

+

Creates a directory inside a Workspace.

+

+ moveDirectory(workspace, body=None, x__xgafv=None)

+

Moves a directory (inside a Workspace), and all of its contents, to a new location.

+

+ moveFile(workspace, body=None, x__xgafv=None)

+

Moves a file (inside a Workspace) to a new location.

+

+ pull(name, body=None, x__xgafv=None)

+

Pulls Git commits from the Repository's remote into a Workspace.

+

+ push(name, body=None, x__xgafv=None)

+

Pushes Git commits from a Workspace to the Repository's remote.

+

+ queryDirectoryContents(workspace, pageSize=None, pageToken=None, path=None, x__xgafv=None)

+

Returns the contents of a given Workspace directory.

+

+ queryDirectoryContents_next()

+

Retrieves the next page of results.

+

+ readFile(workspace, path=None, revision=None, x__xgafv=None)

+

Returns the contents of a file (inside a Workspace).

+

+ removeDirectory(workspace, body=None, x__xgafv=None)

+

Deletes a directory (inside a Workspace) and all of its contents.

+

+ removeFile(workspace, body=None, x__xgafv=None)

+

Deletes a file (inside a Workspace).

+

+ reset(name, body=None, x__xgafv=None)

+

Performs a Git reset for uncommitted files in a Workspace.

+

+ searchFiles(workspace, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Finds the contents of a given Workspace directory by filter.

+

+ searchFiles_next()

+

Retrieves the next page of results.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

+ writeFile(workspace, body=None, x__xgafv=None)

+

Writes to a file (inside a Workspace).

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ commit(name, body=None, x__xgafv=None) +
Applies a Git commit for uncommitted files in a Workspace.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `CommitWorkspaceChanges` request message.
+  "author": { # Represents the author of a Git commit. # Required. The commit's author.
+    "emailAddress": "A String", # Required. The commit author's email address.
+    "name": "A String", # Required. The commit author's name.
+  },
+  "commitMessage": "A String", # Optional. The commit's message.
+  "paths": [ # Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `CommitWorkspaceChanges` response message.
+}
+
+ +
+ create(parent, body=None, workspaceId=None, x__xgafv=None) +
Creates a new Workspace in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform Git workspace.
+  "createTime": "A String", # Output only. The timestamp of when the workspace was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The workspace's name.
+}
+
+  workspaceId: string, Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform Git workspace.
+  "createTime": "A String", # Output only. The timestamp of when the workspace was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The workspace's name.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a single Workspace.
+
+Args:
+  name: string, Required. The workspace resource's name. (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); }
+}
+
+ +
+ fetchFileDiff(workspace, path=None, x__xgafv=None) +
Fetches Git diff for an uncommitted file in a Workspace.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  path: string, Required. The file's full path including filename, relative to the workspace root.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `FetchFileDiff` response message.
+  "formattedDiff": "A String", # The raw formatted Git diff for the file.
+}
+
+ +
+ fetchFileGitStatuses(name, x__xgafv=None) +
Fetches Git statuses for the files in a Workspace.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `FetchFileGitStatuses` response message.
+  "uncommittedFileChanges": [ # A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.
+    { # Represents the Git state of a file with uncommitted changes.
+      "path": "A String", # The file's full path including filename, relative to the workspace root.
+      "state": "A String", # Output only. Indicates the status of the file.
+    },
+  ],
+}
+
+ +
+ fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None) +
Fetches Git ahead/behind against a remote branch.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  remoteBranch: string, Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `FetchGitAheadBehind` response message.
+  "commitsAhead": 42, # The number of commits in the remote branch that are not in the workspace.
+  "commitsBehind": 42, # The number of commits in the workspace that are not in the remote branch.
+}
+
+ +
+ get(name, x__xgafv=None) +
Fetches a single Workspace.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Dataform Git workspace.
+  "createTime": "A String", # Output only. The timestamp of when the workspace was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The workspace's name.
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ installNpmPackages(workspace, body=None, x__xgafv=None) +
Installs dependency NPM packages (inside a Workspace).
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `InstallNpmPackages` request message.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `InstallNpmPackages` response message.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Workspaces in a given Repository.
+
+Args:
+  parent: string, Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  filter: string, Optional. Filter for the returned list.
+  orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+  pageSize: integer, Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, 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:
+
+    { # `ListWorkspaces` response message.
+  "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.
+  "unreachable": [ # Locations which could not be reached.
+    "A String",
+  ],
+  "workspaces": [ # List of workspaces.
+    { # Represents a Dataform Git workspace.
+      "createTime": "A String", # Output only. The timestamp of when the workspace was created.
+      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
+        "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+      },
+      "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+      "name": "A String", # Identifier. The workspace's name.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ makeDirectory(workspace, body=None, x__xgafv=None) +
Creates a directory inside a Workspace.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `MakeDirectory` request message.
+  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `MakeDirectory` response message.
+}
+
+ +
+ moveDirectory(workspace, body=None, x__xgafv=None) +
Moves a directory (inside a Workspace), and all of its contents, to a new location.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `MoveDirectory` request message.
+  "newPath": "A String", # Required. The new path for the directory including directory name, rooted at workspace root.
+  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `MoveDirectory` response message.
+}
+
+ +
+ moveFile(workspace, body=None, x__xgafv=None) +
Moves a file (inside a Workspace) to a new location.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `MoveFile` request message.
+  "newPath": "A String", # Required. The file's new path including filename, relative to the workspace root.
+  "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `MoveFile` response message.
+}
+
+ +
+ pull(name, body=None, x__xgafv=None) +
Pulls Git commits from the Repository's remote into a Workspace.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `PullGitCommits` request message.
+  "author": { # Represents the author of a Git commit. # Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.
+    "emailAddress": "A String", # Required. The commit author's email address.
+    "name": "A String", # Required. The commit author's name.
+  },
+  "remoteBranch": "A String", # Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `PullGitCommits` response message.
+}
+
+ +
+ push(name, body=None, x__xgafv=None) +
Pushes Git commits from a Workspace to the Repository's remote.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `PushGitCommits` request message.
+  "remoteBranch": "A String", # Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `PushGitCommits` response message.
+}
+
+ +
+ queryDirectoryContents(workspace, pageSize=None, pageToken=None, path=None, x__xgafv=None) +
Returns the contents of a given Workspace directory.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
+  path: string, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `QueryDirectoryContents` response message.
+  "directoryEntries": [ # List of entries in the directory.
+    { # Represents a single entry in a directory.
+      "directory": "A String", # A child directory in the directory.
+      "file": "A String", # A file in the directory.
+    },
+  ],
+  "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.
+}
+
+ +
+ queryDirectoryContents_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.
+        
+
+ +
+ readFile(workspace, path=None, revision=None, x__xgafv=None) +
Returns the contents of a file (inside a Workspace).
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  path: string, Required. The file's full path including filename, relative to the workspace root.
+  revision: string, Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `ReadFile` response message.
+  "fileContents": "A String", # The file's contents.
+}
+
+ +
+ removeDirectory(workspace, body=None, x__xgafv=None) +
Deletes a directory (inside a Workspace) and all of its contents.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `RemoveDirectory` request message.
+  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `RemoveDirectory` response message.
+}
+
+ +
+ removeFile(workspace, body=None, x__xgafv=None) +
Deletes a file (inside a Workspace).
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `RemoveFile` request message.
+  "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `RemoveFile` response message.
+}
+
+ +
+ reset(name, body=None, x__xgafv=None) +
Performs a Git reset for uncommitted files in a Workspace.
+
+Args:
+  name: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `ResetWorkspaceChanges` request message.
+  "clean": True or False, # Optional. If set to true, untracked files will be deleted.
+  "paths": [ # Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `ResetWorkspaceChanges` response message.
+}
+
+ +
+ searchFiles(workspace, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Finds the contents of a given Workspace directory by filter.
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  filter: string, Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details.
+  pageSize: integer, Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, 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:
+
+    { # Client-facing representation of a file search response.
+  "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "searchResults": [ # List of matched results.
+    { # Client-facing representation of a search result entry.
+      "directory": { # Client-facing representation of a directory entry in search results. # Details when search result is a directory.
+        "path": "A String", # File system path relative to the workspace root.
+      },
+      "file": { # Client-facing representation of a file entry in search results. # Details when search result is a file.
+        "path": "A String", # File system path relative to the workspace root.
+      },
+    },
+  ],
+}
+
+ +
+ searchFiles_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.
+        
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ +
+ writeFile(workspace, body=None, x__xgafv=None) +
Writes to a file (inside a Workspace).
+
+Args:
+  workspace: string, Required. The workspace's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `WriteFile` request message.
+  "contents": "A String", # Required. The file's contents.
+  "path": "A String", # Required. The file.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `WriteFile` response message.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataform_v1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1.projects.locations.teamFolders.html new file mode 100644 index 0000000000..0ef4e6dbd7 --- /dev/null +++ b/docs/dyn/dataform_v1.projects.locations.teamFolders.html @@ -0,0 +1,218 @@ + + + +

Dataform API . projects . locations . teamFolders

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html b/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html index a5c7bed813..650217cf5c 100644 --- a/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html +++ b/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html @@ -124,6 +124,7 @@

Method Details

"alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types. }, "createTime": "A String", # Output only. The time when the AspectType was created. + "dataClassification": "A String", # Optional. Immutable. Stores data classification of the aspect. "description": "A String", # Optional. Description of the AspectType. "displayName": "A String", # Optional. User friendly display name. "etag": "A String", # The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. @@ -254,6 +255,7 @@

Method Details

"alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types. }, "createTime": "A String", # Output only. The time when the AspectType was created. + "dataClassification": "A String", # Optional. Immutable. Stores data classification of the aspect. "description": "A String", # Optional. Description of the AspectType. "displayName": "A String", # Optional. User friendly display name. "etag": "A String", # The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. @@ -372,6 +374,7 @@

Method Details

"alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types. }, "createTime": "A String", # Output only. The time when the AspectType was created. + "dataClassification": "A String", # Optional. Immutable. Stores data classification of the aspect. "description": "A String", # Optional. Description of the AspectType. "displayName": "A String", # Optional. User friendly display name. "etag": "A String", # The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. @@ -451,6 +454,7 @@

Method Details

"alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types. }, "createTime": "A String", # Output only. The time when the AspectType was created. + "dataClassification": "A String", # Optional. Immutable. Stores data classification of the aspect. "description": "A String", # Optional. Description of the AspectType. "displayName": "A String", # Optional. User friendly display name. "etag": "A String", # The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index c3c1ffb7ba..049d47ecf6 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -281,7 +281,7 @@

Method Details

BASIC - Returns entry only, without aspects. FULL - Returns all required aspects as well as the keys of all non-required aspects. CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned. - ALL - Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned. + ALL - x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 966d1f33f3..5e23cbbad5 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -263,7 +263,7 @@

Method Details

BASIC - Returns entry only, without aspects. FULL - Returns all required aspects as well as the keys of all non-required aspects. CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned. - ALL - Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned. + ALL - x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html index 682fe1f0ba..eabc9c09fa 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.html @@ -227,8 +227,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -439,8 +439,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -609,8 +609,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. diff --git a/docs/dyn/dataproc_v1.projects.locations.operations.html b/docs/dyn/dataproc_v1.projects.locations.operations.html index ff37c70f2c..61f666ba5b 100644 --- a/docs/dyn/dataproc_v1.projects.locations.operations.html +++ b/docs/dyn/dataproc_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.html b/docs/dyn/dataproc_v1.projects.locations.sessions.html index ad0a9325f7..18325a649f 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.html @@ -169,8 +169,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -351,8 +351,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -473,8 +473,8 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any + "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index ce56e58277..14138f3739 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -522,7 +522,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -1232,7 +1232,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -1969,7 +1969,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -2770,7 +2770,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -3521,7 +3521,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -4340,7 +4340,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -5050,7 +5050,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 7aea88443e..b944109eb3 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -266,7 +266,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -925,7 +925,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -1545,7 +1545,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -2085,7 +2085,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. diff --git a/docs/dyn/dataproc_v1.projects.regions.jobs.html b/docs/dyn/dataproc_v1.projects.regions.jobs.html index a1a321e9bc..b529aa2f7a 100644 --- a/docs/dyn/dataproc_v1.projects.regions.jobs.html +++ b/docs/dyn/dataproc_v1.projects.regions.jobs.html @@ -394,10 +394,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], } @@ -705,10 +707,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], } @@ -1044,10 +1048,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], }, @@ -1345,10 +1351,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], } @@ -1623,10 +1631,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], } @@ -1962,10 +1972,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], }, @@ -2241,10 +2253,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], } @@ -2522,10 +2536,12 @@

Method Details

}, "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + "memoryMbSeconds": "A String", # Optional. The cumulative memory usage of the application for a job, measured in mb-seconds. "name": "A String", # Required. The application name. "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. "state": "A String", # Required. The application state. "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + "vcoreSeconds": "A String", # Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds. }, ], }, diff --git a/docs/dyn/dataproc_v1.projects.regions.operations.html b/docs/dyn/dataproc_v1.projects.regions.operations.html index 45a9eba8b3..f6cf67321e 100644 --- a/docs/dyn/dataproc_v1.projects.regions.operations.html +++ b/docs/dyn/dataproc_v1.projects.regions.operations.html @@ -90,7 +90,7 @@

Instance Methods

getIamPolicy(resource, body=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -222,7 +222,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -230,6 +230,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -261,6 +262,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index de879627cd..dacaff0434 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -522,7 +522,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -1232,7 +1232,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -1969,7 +1969,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -2770,7 +2770,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -3521,7 +3521,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -4340,7 +4340,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. @@ -5050,7 +5050,7 @@

Method Details

"A String", ], }, - "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + "resourceManagerTags": { # Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). "a_key": "A String", }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. diff --git a/docs/dyn/dfareporting_v4.dynamicFeeds.html b/docs/dyn/dfareporting_v4.dynamicFeeds.html index 3ed750128c..821e96e3c2 100644 --- a/docs/dyn/dfareporting_v4.dynamicFeeds.html +++ b/docs/dyn/dfareporting_v4.dynamicFeeds.html @@ -83,6 +83,12 @@

Instance Methods

insert(body=None, x__xgafv=None)

Inserts a new dynamic feed.

+

+ retransform(dynamicFeedId, x__xgafv=None)

+

Retransforms a dynamic feed.

+

+ update(body=None, x__xgafv=None)

+

Updates a new dynamic feed.

Method Details

close() @@ -206,7 +212,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface +{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See "dynamicFeed": { # Contains dynamic feed information. # Required. Dynamic feed to insert. "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field. "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided. @@ -406,4 +412,318 @@

Method Details

}
+
+ retransform(dynamicFeedId, x__xgafv=None) +
Retransforms a dynamic feed.
+
+Args:
+  dynamicFeedId: string, Required. Dynamic feed ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+ +
+ update(body=None, x__xgafv=None) +
Updates a new dynamic feed.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dfareporting_v4.dynamicProfiles.html b/docs/dyn/dfareporting_v4.dynamicProfiles.html index 4f39bef6a4..a2cc237039 100644 --- a/docs/dyn/dfareporting_v4.dynamicProfiles.html +++ b/docs/dyn/dfareporting_v4.dynamicProfiles.html @@ -77,12 +77,18 @@

Instance Methods

close()

Close httplib2 connections.

+

+ generateCode(dynamicProfileId, x__xgafv=None)

+

Generates code for a dynamic profile.

get(dynamicProfileId, x__xgafv=None)

Gets a dynamic profile by ID.

insert(body=None, x__xgafv=None)

Inserts a new dynamic profile.

+

+ publish(dynamicProfileId, x__xgafv=None)

+

Publish for a dynamic profile.

update(body=None, x__xgafv=None)

Updates an existing dynamic profile.

@@ -92,6 +98,25 @@

Method Details

Close httplib2 connections.
+
+ generateCode(dynamicProfileId, x__xgafv=None) +
Generates code for a dynamic profile.
+
+Args:
+  dynamicProfileId: string, Required. Dynamic 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:
+
+    { # Response message for DfareportingDynamicProfiles.GenerateCode.
+  "code": "A String", # Generated code for the dynamic profile.
+}
+
+
get(dynamicProfileId, x__xgafv=None)
Gets a dynamic profile by ID.
@@ -586,6 +611,19 @@ 

Method Details

}
+
+ publish(dynamicProfileId, x__xgafv=None) +
Publish for a dynamic profile.
+
+Args:
+  dynamicProfileId: string, Required. Dynamic profile ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+
update(body=None, x__xgafv=None)
Updates an existing dynamic profile.
diff --git a/docs/dyn/dfareporting_v4.html b/docs/dyn/dfareporting_v4.html
index b163825f1c..c45505d2d2 100644
--- a/docs/dyn/dfareporting_v4.html
+++ b/docs/dyn/dfareporting_v4.html
@@ -359,6 +359,16 @@ 

Instance Methods

Returns the sizes Resource.

+

+ studioCreativeAssets() +

+

Returns the studioCreativeAssets Resource.

+ +

+ studioCreatives() +

+

Returns the studioCreatives Resource.

+

subaccounts()

diff --git a/docs/dyn/dfareporting_v4.studioCreativeAssets.html b/docs/dyn/dfareporting_v4.studioCreativeAssets.html new file mode 100644 index 0000000000..da16198ef7 --- /dev/null +++ b/docs/dyn/dfareporting_v4.studioCreativeAssets.html @@ -0,0 +1,138 @@ + + + +

Campaign Manager 360 API . studioCreativeAssets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ insert(body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Inserts a new studio creative asset.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ insert(body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Inserts a new studio creative asset.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for DfareportingStudioCreativeAssets.Insert.
+  "studioAccountId": "A String", # Optional. Studio account ID of the studio creative asset. It is a optional.
+  "studioAdvertiserId": "A String", # Required. Studio advertiser ID of the studio creative asset. It is a required field on insertion.
+  "studioCreativeId": "A String", # Optional. Studio creative ID of the studio creative asset. It is a optional field. If it is set, the asset will be associated to the creative.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for DfareportingStudioCreativeAssets.Insert.
+  "assets": [ # The list of studio creative assets.
+    { # Contains studio creative asset information.
+      "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the studio creative asset. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "filename": "A String", # The filename of the studio creative asset. It is default to the original filename of the asset.
+      "filesize": "A String", # The filesize of the studio creative asset. This is a read-only field.
+      "id": "A String", # Output only. Unique ID of this studio creative asset. This is a read-only, auto-generated field.
+      "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the studio creative asset. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "studioAccountId": "A String", # Studio account ID of this studio creative asset. This field, if left unset, will be auto-populated..
+      "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative asset. This is a required field on insertion.
+      "studioCreativeId": "A String", # Studio creative ID of this studio creative asset. The asset will be associated to the creative if creative id is set.
+      "type": "A String", # The type of the studio creative asset. It is a auto-generated, read-only field.
+      "videoProcessingData": { # Contains processing data for a video asset. # The processing data of the studio creative asset. This is a read-only field.
+        "errorReason": "A String", # For a FAILED processing state, the error reason discovered.
+        "processingState": "A String", # Output only. The processing state of the studio creative asset.
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v4.studioCreatives.html b/docs/dyn/dfareporting_v4.studioCreatives.html new file mode 100644 index 0000000000..477b09bd11 --- /dev/null +++ b/docs/dyn/dfareporting_v4.studioCreatives.html @@ -0,0 +1,215 @@ + + + +

Campaign Manager 360 API . studioCreatives

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(studioCreativeId, x__xgafv=None)

+

Gets a studio creative by ID.

+

+ insert(body=None, x__xgafv=None)

+

Inserts a new studio creative.

+

+ publish(studioCreativeId, x__xgafv=None)

+

Publish for a studio creative.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(studioCreativeId, x__xgafv=None) +
Gets a studio creative by ID.
+
+Args:
+  studioCreativeId: string, Required. Studio creative ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+ +
+ insert(body=None, x__xgafv=None) +
Inserts a new studio creative.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+ +
+ publish(studioCreativeId, x__xgafv=None) +
Publish for a studio creative.
+
+Args:
+  studioCreativeId: string, Required. Studio creative ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v5.dynamicFeeds.html b/docs/dyn/dfareporting_v5.dynamicFeeds.html index e52b02ca75..dbb88e9434 100644 --- a/docs/dyn/dfareporting_v5.dynamicFeeds.html +++ b/docs/dyn/dfareporting_v5.dynamicFeeds.html @@ -83,6 +83,12 @@

Instance Methods

insert(body=None, x__xgafv=None)

Inserts a new dynamic feed.

+

+ retransform(dynamicFeedId, x__xgafv=None)

+

Retransforms a dynamic feed.

+

+ update(body=None, x__xgafv=None)

+

Updates a new dynamic feed.

Method Details

close() @@ -206,7 +212,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface +{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See "dynamicFeed": { # Contains dynamic feed information. # Required. Dynamic feed to insert. "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field. "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided. @@ -406,4 +412,318 @@

Method Details

}
+
+ retransform(dynamicFeedId, x__xgafv=None) +
Retransforms a dynamic feed.
+
+Args:
+  dynamicFeedId: string, Required. Dynamic feed ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+ +
+ update(body=None, x__xgafv=None) +
Updates a new dynamic feed.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains dynamic feed information.
+  "contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
+    "contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
+      "charset": "A String", # Output only. The charset of the content source.
+      "fieldNames": [ # Output only. The list of column names in the content source.
+        "A String",
+      ],
+      "rowNumber": 42, # Output only. The number of rows in the content source.
+      "separator": "A String", # Output only. The separator of the content source.
+    },
+    "resourceLink": "A String", # Required. The link to the file of the content source.
+    "resourceType": "A String", # Required. The resource type of the content source.
+  },
+  "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
+  "dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
+  "element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
+    "activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
+    "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
+    "elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
+    "endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+    "externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
+    "feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
+      { # Each field of the element. This is a required field.
+        "defaultValue": "A String", # Optional. The default value of the field.
+        "filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
+        "id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
+        "name": "A String", # Required. The name of the field.
+        "renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
+        "required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
+        "type": "A String", # Required. The type of the field.
+      },
+    ],
+    "isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
+    "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
+    "reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
+    "startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
+  },
+  "feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
+    "ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
+      { # Contains the ingestion error record of the dynamic feed. limited to 100 records.
+        "errors": [ # Output only. The list of field errors of the ingestion error record.
+          { # Contains the field error of the dynamic feed.
+            "fieldId": 42, # Output only. The ID of the field.
+            "fieldName": "A String", # Output only. The name of the field.
+            "fieldValues": [ # Output only. The list of values of the field.
+              "A String",
+            ],
+            "ingestionError": "A String", # Output only. The ingestion error of the field.
+            "isError": True or False, # Output only. Incidcates whether the field has error or warning.
+          },
+        ],
+        "recordId": "A String", # Output only. The record ID of the ingestion error record.
+      },
+    ],
+    "ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
+      "numActiveRows": "A String", # Output only. The number of active rows in the feed.
+      "numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
+      "numRowsTotal": "A String", # Output only. The total number of rows in the feed.
+      "numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
+      "numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
+    },
+    "state": "A String", # Output only. The processing state of the feed.
+  },
+  "feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
+    "repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
+    "scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
+    "startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
+    "timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
+  },
+  "hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
+  "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
+  "studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dfareporting_v5.dynamicProfiles.html b/docs/dyn/dfareporting_v5.dynamicProfiles.html index f7bda31a57..bd3296ca2b 100644 --- a/docs/dyn/dfareporting_v5.dynamicProfiles.html +++ b/docs/dyn/dfareporting_v5.dynamicProfiles.html @@ -77,12 +77,18 @@

Instance Methods

close()

Close httplib2 connections.

+

+ generateCode(dynamicProfileId, x__xgafv=None)

+

Generates code for a dynamic profile.

get(dynamicProfileId, x__xgafv=None)

Gets a dynamic profile by ID.

insert(body=None, x__xgafv=None)

Inserts a new dynamic profile.

+

+ publish(dynamicProfileId, x__xgafv=None)

+

Publish for a dynamic profile.

update(body=None, x__xgafv=None)

Updates an existing dynamic profile.

@@ -92,6 +98,25 @@

Method Details

Close httplib2 connections.
+
+ generateCode(dynamicProfileId, x__xgafv=None) +
Generates code for a dynamic profile.
+
+Args:
+  dynamicProfileId: string, Required. Dynamic 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:
+
+    { # Response message for DfareportingDynamicProfiles.GenerateCode.
+  "code": "A String", # Generated code for the dynamic profile.
+}
+
+
get(dynamicProfileId, x__xgafv=None)
Gets a dynamic profile by ID.
@@ -586,6 +611,19 @@ 

Method Details

}
+
+ publish(dynamicProfileId, x__xgafv=None) +
Publish for a dynamic profile.
+
+Args:
+  dynamicProfileId: string, Required. Dynamic profile ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+
update(body=None, x__xgafv=None)
Updates an existing dynamic profile.
diff --git a/docs/dyn/dfareporting_v5.html b/docs/dyn/dfareporting_v5.html
index 7d664f8c5e..edcffc8bfe 100644
--- a/docs/dyn/dfareporting_v5.html
+++ b/docs/dyn/dfareporting_v5.html
@@ -344,6 +344,16 @@ 

Instance Methods

Returns the sizes Resource.

+

+ studioCreativeAssets() +

+

Returns the studioCreativeAssets Resource.

+ +

+ studioCreatives() +

+

Returns the studioCreatives Resource.

+

subaccounts()

diff --git a/docs/dyn/dfareporting_v5.studioCreativeAssets.html b/docs/dyn/dfareporting_v5.studioCreativeAssets.html new file mode 100644 index 0000000000..9fc0e7391e --- /dev/null +++ b/docs/dyn/dfareporting_v5.studioCreativeAssets.html @@ -0,0 +1,138 @@ + + + +

Campaign Manager 360 API . studioCreativeAssets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ insert(body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Inserts a new studio creative asset.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ insert(body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Inserts a new studio creative asset.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for DfareportingStudioCreativeAssets.Insert.
+  "studioAccountId": "A String", # Optional. Studio account ID of the studio creative asset. It is a optional.
+  "studioAdvertiserId": "A String", # Required. Studio advertiser ID of the studio creative asset. It is a required field on insertion.
+  "studioCreativeId": "A String", # Optional. Studio creative ID of the studio creative asset. It is a optional field. If it is set, the asset will be associated to the creative.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for DfareportingStudioCreativeAssets.Insert.
+  "assets": [ # The list of studio creative assets.
+    { # Contains studio creative asset information.
+      "createInfo": { # Modification timestamp. # Output only. The creation timestamp of the studio creative asset. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "filename": "A String", # The filename of the studio creative asset. It is default to the original filename of the asset.
+      "filesize": "A String", # The filesize of the studio creative asset. This is a read-only field.
+      "id": "A String", # Output only. Unique ID of this studio creative asset. This is a read-only, auto-generated field.
+      "lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the studio creative asset. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "studioAccountId": "A String", # Studio account ID of this studio creative asset. This field, if left unset, will be auto-populated..
+      "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative asset. This is a required field on insertion.
+      "studioCreativeId": "A String", # Studio creative ID of this studio creative asset. The asset will be associated to the creative if creative id is set.
+      "type": "A String", # The type of the studio creative asset. It is a auto-generated, read-only field.
+      "videoProcessingData": { # Contains processing data for a video asset. # The processing data of the studio creative asset. This is a read-only field.
+        "errorReason": "A String", # For a FAILED processing state, the error reason discovered.
+        "processingState": "A String", # Output only. The processing state of the studio creative asset.
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v5.studioCreatives.html b/docs/dyn/dfareporting_v5.studioCreatives.html new file mode 100644 index 0000000000..2aaef1d180 --- /dev/null +++ b/docs/dyn/dfareporting_v5.studioCreatives.html @@ -0,0 +1,215 @@ + + + +

Campaign Manager 360 API . studioCreatives

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(studioCreativeId, x__xgafv=None)

+

Gets a studio creative by ID.

+

+ insert(body=None, x__xgafv=None)

+

Inserts a new studio creative.

+

+ publish(studioCreativeId, x__xgafv=None)

+

Publish for a studio creative.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(studioCreativeId, x__xgafv=None) +
Gets a studio creative by ID.
+
+Args:
+  studioCreativeId: string, Required. Studio creative ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+ +
+ insert(body=None, x__xgafv=None) +
Inserts a new studio creative.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains studio creative information.
+  "assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
+    "A String",
+  ],
+  "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+  "createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "dimension": { # Dimension information for a studio creative. # Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING.
+    "height": 42, # Height of the studio creative.
+    "width": 42, # Width of the studio creative.
+  },
+  "dynamicProfileId": "A String", # Dynamic profile ID of this studio creative.
+  "format": "A String", # Format of this studio creative. This is a required field on insertion.
+  "id": "A String", # Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.
+  "lastModifiedInfo": { # Modification timestamp. # The timestamp when the studio creative was last modified. This is a read-only, auto-generated field.
+    "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+  },
+  "name": "A String", # Identifier. Name of this studio creative. This is a required field on insertion.
+  "status": "A String", # Output only. Status of this studio creative. It is a read-only field.
+  "studioAccountId": "A String", # Studio account ID of this creative. This field, if left unset, will be auto-populated.
+  "studioAdvertiserId": "A String", # Studio advertiser ID of this studio creative. This is a required field on insertion.
+  "studioCampaignId": "A String", # Studio campaign ID of this studio creative. This is a required field on insertion.
+}
+
+ +
+ publish(studioCreativeId, x__xgafv=None) +
Publish for a studio creative.
+
+Args:
+  studioCreativeId: string, Required. Studio creative ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index db7f6ecbca..3f24cde975 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -3246,6 +3246,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -9894,6 +9899,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index 3a4bca545f..7c505d1ca7 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -189,6 +189,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -2648,6 +2653,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -5081,6 +5091,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -6429,6 +6444,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html index 2341bee40a..cb8b684a18 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html @@ -114,6 +114,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. @@ -147,6 +152,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. @@ -206,6 +216,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. @@ -250,6 +265,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. @@ -301,6 +321,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. @@ -335,6 +360,11 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. "llmModelSettings": { # Settings for LLM models. # The LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index 81643fe6be..8b60d23769 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -648,6 +648,11 @@

Method Details

"languageCode": "A String", # Language for this settings. "llmModelSettings": { # Settings for LLM models. # LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. @@ -1156,6 +1161,11 @@

Method Details

"languageCode": "A String", # Language for this settings. "llmModelSettings": { # Settings for LLM models. # LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. @@ -1204,6 +1214,11 @@

Method Details

"languageCode": "A String", # Language for this settings. "llmModelSettings": { # Settings for LLM models. # LLM model settings. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html index 7595ea549c..0de94c522a 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html @@ -512,6 +512,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -948,6 +953,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -1452,6 +1462,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -1948,6 +1963,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -2402,6 +2422,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -2839,6 +2864,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html index 1284fd20ed..8cc9e9a45f 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html @@ -731,6 +731,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -1404,6 +1409,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -2102,6 +2112,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -2787,6 +2802,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. @@ -3255,6 +3275,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index edb142fc02..14d22e8112 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -192,6 +192,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -2651,6 +2656,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -5084,6 +5094,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. @@ -6432,6 +6447,11 @@

Method Details

}, "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. "model": "A String", # The selected LLM model. + "parameters": { # Generative model parameters to control the model behavior. # Generative model parameters. + "inputTokenLimit": "A String", # The input token limit. This setting is currently only supported by playbooks. + "outputTokenLimit": "A String", # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set. + "temperature": 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0] + }, "promptText": "A String", # The custom prompt to use. }, "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 4710bf0417..eb303bd261 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -421,6 +421,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -595,6 +598,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -2224,6 +2243,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -2398,6 +2420,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html index 6cd6aa32ca..4f588f681f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -293,6 +296,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -368,6 +387,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -542,6 +564,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -643,6 +681,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -817,6 +858,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -906,6 +963,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1080,6 +1140,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1173,6 +1249,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1347,6 +1426,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1423,6 +1518,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1597,6 +1695,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html index 4f34855f04..8200dfef3e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html @@ -333,6 +333,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -385,7 +401,7 @@

Method Details

"state": "A String", # State of the answer generation. }, "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. - "sessionInfo": { # Information about the session. # Session information. + "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index fe89d51dbd..351de87369 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -421,6 +421,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -595,6 +598,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -2224,6 +2243,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -2398,6 +2420,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html index 87450e75d4..7fad073a49 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -293,6 +296,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -368,6 +387,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -542,6 +564,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -643,6 +681,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -817,6 +858,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -906,6 +963,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1080,6 +1140,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1173,6 +1249,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1347,6 +1426,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1423,6 +1518,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1597,6 +1695,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index feb234373f..f0c6fee9fb 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -421,6 +421,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -595,6 +598,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -2224,6 +2243,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -2398,6 +2420,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index cbe97afd56..12699a35a6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -293,6 +296,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -368,6 +387,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -542,6 +564,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -643,6 +681,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -817,6 +858,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -906,6 +963,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1080,6 +1140,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1173,6 +1249,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1347,6 +1426,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1423,6 +1518,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1597,6 +1695,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html index 4f56c0ca34..697d5ce2ca 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html @@ -102,24 +102,6 @@

Method Details

The object takes the form of: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -127,6 +109,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -149,24 +132,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -174,6 +139,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -202,24 +168,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -227,6 +175,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -250,24 +199,6 @@

Method Details

The object takes the form of: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -275,6 +206,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -297,24 +229,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -322,6 +236,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 155f4b8005..9d8db7ad43 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -461,6 +461,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -650,6 +653,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3070,6 +3089,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3259,6 +3281,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html index 49f3c8a168..2b19c9d7e6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -308,6 +311,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -384,6 +403,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -573,6 +595,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -675,6 +713,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -864,6 +905,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -954,6 +1011,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1143,6 +1203,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1237,6 +1313,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1426,6 +1505,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1503,6 +1598,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1692,6 +1790,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html index 196121e0b9..3fc9f32904 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -333,6 +333,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -386,7 +402,7 @@

Method Details

"state": "A String", # State of the answer generation. }, "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. - "sessionInfo": { # Information about the session. # Session information. + "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 0688195cdb..7e996597b8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -461,6 +461,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -650,6 +653,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3070,6 +3089,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3259,6 +3281,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html index b217d84f71..0793979de6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -124,6 +124,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -313,6 +316,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -389,6 +408,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -578,6 +600,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -680,6 +718,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -869,6 +910,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -959,6 +1016,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1148,6 +1208,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1242,6 +1318,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1431,6 +1510,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1508,6 +1603,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1697,6 +1795,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 7a68c3a6eb..76f84fc02c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -461,6 +461,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -650,6 +653,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3070,6 +3089,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3259,6 +3281,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 8a3ac91647..3da3394614 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -308,6 +311,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -384,6 +403,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -573,6 +595,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -675,6 +713,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -864,6 +905,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -954,6 +1011,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1143,6 +1203,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1237,6 +1313,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1426,6 +1505,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1503,6 +1598,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1692,6 +1790,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index fb9c7384f8..b8b4e09277 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -161,6 +161,9 @@

Instance Methods

getCmekConfig(name, x__xgafv=None)

Gets the CmekConfig.

+

+ getConfigurablePricingUsageStats(name, metricTypes=None, timeRange_endDate_day=None, timeRange_endDate_month=None, timeRange_endDate_year=None, timeRange_startDate_day=None, timeRange_startDate_month=None, timeRange_startDate_year=None, x__xgafv=None)

+

Gets configurable pricing usage stats.

obtainCrawlRate(location, body=None, x__xgafv=None)

Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.

@@ -313,6 +316,57 @@

Method Details

}
+
+ getConfigurablePricingUsageStats(name, metricTypes=None, timeRange_endDate_day=None, timeRange_endDate_month=None, timeRange_endDate_year=None, timeRange_startDate_day=None, timeRange_startDate_month=None, timeRange_startDate_year=None, x__xgafv=None) +
Gets configurable pricing usage stats.
+
+Args:
+  name: string, Required. The name of the ConfigurablePricingUsageStats to retrieve. Format: projects/{project}/locations/{location}/configurablePricingUsageStats (required)
+  metricTypes: string, Optional. The metric types to return usage for. (repeated)
+    Allowed values
+      BILLING_METRIC_TYPE_UNSPECIFIED - Default value.
+      DAILY_MDN_QPM - Daily median search request QPM.
+      DAILY_MIN_QPM - Daily min search request QPM.
+      DAILY_MAX_QPM - Daily max search request QPM.
+      DAILY_SEARCH_REQUEST - Daily search request total.
+      TOTAL_STORAGE - Total storage bytes for indexing core.
+  timeRange_endDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+  timeRange_endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  timeRange_endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  timeRange_startDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+  timeRange_startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  timeRange_startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for [EstimateBillingService.GetConfigurablePricingUsageStats] method.
+  "metricUsages": [ # A list of metric usages, one for each requested resource type that has data in the requested time range.
+    { # The usage of a metric over a list of days.
+      "datedUsages": [ # The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.
+        { # A list of usages for a specific day.
+          "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date of the usage.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "usage": 3.14, # The usage value on the date.
+        },
+      ],
+      "metricType": "A String", # The metric type.
+      "totalUsages": [ # The list of total usages for this resource type
+        3.14,
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. The name of the ConfigurablePricingUsageStats. Format: projects/{project}/locations/{location}/configurablePricingUsageStats
+}
+
+
obtainCrawlRate(location, body=None, x__xgafv=None)
Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
index bba1c4f611..e7824d74ce 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
@@ -127,6 +127,7 @@ 

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -174,6 +175,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -227,6 +229,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -275,6 +278,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -322,6 +326,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 731e1df9d5..c3292d0227 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -458,6 +458,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -647,6 +650,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3023,6 +3042,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3212,6 +3234,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html index 81bae4f2fc..c4322c28ee 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -308,6 +311,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -383,6 +402,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -572,6 +594,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -673,6 +711,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -862,6 +903,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -951,6 +1008,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1140,6 +1200,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1233,6 +1309,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1422,6 +1501,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1498,6 +1593,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1687,6 +1785,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html index 0cd1b31f29..487d1ea08a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html @@ -333,6 +333,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -385,7 +401,7 @@

Method Details

"state": "A String", # State of the answer generation. }, "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. - "sessionInfo": { # Information about the session. # Session information. + "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, }
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 2831ab131a..9cbe47797b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -458,6 +458,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -647,6 +650,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3023,6 +3042,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3212,6 +3234,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html index da45fdd215..aa69abec37 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -308,6 +311,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -383,6 +402,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -572,6 +594,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -673,6 +711,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -862,6 +903,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -951,6 +1008,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1140,6 +1200,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1233,6 +1309,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1422,6 +1501,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1498,6 +1593,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1687,6 +1785,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 74da1b678c..844c59de60 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -458,6 +458,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -647,6 +650,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -3023,6 +3042,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -3212,6 +3234,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index d2c7f01d07..dd4e60e34f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -119,6 +119,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -308,6 +311,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -383,6 +402,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -572,6 +594,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -673,6 +711,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -862,6 +903,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -951,6 +1008,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1140,6 +1200,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1233,6 +1309,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1422,6 +1501,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. @@ -1498,6 +1593,9 @@

Method Details

"displayName": "A String", # Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. "endTime": "A String", # Output only. The time the session finished. "isPinned": True or False, # Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. + "labels": [ # Optional. The labels for the session. Can be set as filter in ListSessionsRequest. + "A String", + ], "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` "startTime": "A String", # Output only. The time the session started. "state": "A String", # The state of the session. @@ -1687,6 +1785,22 @@

Method Details

"replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check + "citations": [ # Output only. List of citations. + { # Source attributions for content. + "endIndex": 42, # Output only. End index into the content. + "license": "A String", # Output only. License of the attribution. + "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "startIndex": 42, # Output only. Start index into the content. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. Url reference of the attribution. + }, + ], + }, "content": { # Multi-modal content. # The content. "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html index 577c0eaca0..dfd49aa68a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html @@ -102,24 +102,6 @@

Method Details

The object takes the form of: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -127,6 +109,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -149,24 +132,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -174,6 +139,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -202,24 +168,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -227,6 +175,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -250,24 +199,6 @@

Method Details

The object takes the form of: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -275,6 +206,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -297,24 +229,6 @@

Method Details

An object of the form: { # Information about users' licenses. - "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config. - "alertEnrollments": [ # Optional. The enrollment state of each alert. - { # The alert enrollment status. - "alertId": "A String", # Immutable. The id of an alert. - "enrollState": "A String", # Required. The enrollment status of a customer. - "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails. - "a_key": "A String", - }, - }, - ], - "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy. - "contactDetails": [ # Optional. The contact details for each alert policy. - { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info. - "emailAddress": "A String", # Optional. The email address of the contact. - }, - ], - "languageCode": "A String", # Optional. The language code used for notifications - }, "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -322,6 +236,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "freeTrial": True or False, # Optional. Whether the license config is for free trial. + "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html index 8e884feb8e..65d3065179 100644 --- a/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html @@ -172,7 +172,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html index 55fb983bbc..d99de8a1cf 100644 --- a/docs/dyn/dlp_v2.organizations.locations.connections.html +++ b/docs/dyn/dlp_v2.organizations.locations.connections.html @@ -265,7 +265,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR + filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160. pageSize: integer, Optional. Number of results per page, max 1000. pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request. x__xgafv: string, V1 error format. @@ -422,7 +422,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`. (required) - filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR + filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160. pageSize: integer, Optional. Number of results per page, max 1000. pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index f3863b2c11..b4eb318453 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` pageSize: integer, The standard list page size. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 3f5b4c2296..77eb1f521f 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -886,7 +886,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like "gs://bucket" - `data_source_type`: The profile's data source type, like "google/storage/bucket" - `data_storage_location`: The location where the file store's data is stored, like "us-central1" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like "gs://bucket" - `data_source_type`: The profile's data source type, like "google/storage/bucket" - `data_storage_location`: The location where the file store's data is stored, like "us-central1" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. pageSize: integer, Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Optional. Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 3b84dd7502..2a5cded2bc 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -1200,7 +1200,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. pageSize: integer, Size of the page. This value can be limited by a server. diff --git a/docs/dyn/dlp_v2.organizations.locations.projectDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.projectDataProfiles.html index d090875c44..4b69c8c6b0 100644 --- a/docs/dyn/dlp_v2.organizations.locations.projectDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.projectDataProfiles.html @@ -139,7 +139,7 @@

Method Details

Args: parent: string, Required. organizations/{org_id}/locations/{loc_id} (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_last_generated`: Date and time (in epoch seconds) the profile was last generated pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index dc5e22d875..eb770e745c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -829,7 +829,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 18e78db235..472fb51de8 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -8074,7 +8074,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` pageSize: integer, The standard list page size. diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 9cbc13109a..ae400fbc6f 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -4928,7 +4928,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. pageSize: integer, Size of the page. This value can be limited by a server. diff --git a/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html index 50bb5225c8..521850701b 100644 --- a/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html @@ -172,7 +172,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html index 54b1332be6..bdf9ceeb19 100644 --- a/docs/dyn/dlp_v2.projects.locations.connections.html +++ b/docs/dyn/dlp_v2.projects.locations.connections.html @@ -265,7 +265,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR + filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160. pageSize: integer, Optional. Number of results per page, max 1000. pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request. x__xgafv: string, V1 error format. @@ -422,7 +422,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`. (required) - filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR + filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160. pageSize: integer, Optional. Number of results per page, max 1000. pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 077a5642e3..6725b12ac0 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -8192,7 +8192,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` pageSize: integer, The standard list page size. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 451b094901..5a621b9625 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -886,7 +886,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like "gs://bucket" - `data_source_type`: The profile's data source type, like "google/storage/bucket" - `data_storage_location`: The location where the file store's data is stored, like "us-central1" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like "gs://bucket" - `data_source_type`: The profile's data source type, like "google/storage/bucket" - `data_storage_location`: The location where the file store's data is stored, like "us-central1" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. pageSize: integer, Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Optional. Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 6f53582650..4e41fc02ec 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -5019,7 +5019,7 @@

Method Details

Args: parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. locationId: string, Deprecated. This field has no effect. orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. pageSize: integer, Size of the page. This value can be limited by a server. diff --git a/docs/dyn/dlp_v2.projects.locations.projectDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.projectDataProfiles.html index 1977d41fec..263da52aaf 100644 --- a/docs/dyn/dlp_v2.projects.locations.projectDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.projectDataProfiles.html @@ -139,7 +139,7 @@

Method Details

Args: parent: string, Required. organizations/{org_id}/locations/{loc_id} (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_last_generated`: Date and time (in epoch seconds) the profile was last generated pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 018fb95a10..a4faa70439 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -829,7 +829,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. + filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Page token to continue retrieval. diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index b58f53254b..7b7308da44 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -394,6 +394,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -2892,6 +2895,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -9616,6 +9622,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -11908,6 +11917,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -18631,6 +18643,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -18961,6 +18976,7 @@

Method Details

}, }, "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "iconEmoji": "A String", # Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon. "index": 42, # The zero-based index of the tab within the parent. "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. @@ -20939,6 +20955,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -27663,6 +27682,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -29955,6 +29977,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -36678,6 +36703,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -37008,6 +37036,7 @@

Method Details

}, }, "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "iconEmoji": "A String", # Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon. "index": 42, # The zero-based index of the tab within the parent. "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. @@ -39000,6 +39029,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -45724,6 +45756,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -48016,6 +48051,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -54739,6 +54777,9 @@

Method Details

}, "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). + "documentMode": "A String", # Whether the document has pages or is pageless. + }, "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. @@ -55069,6 +55110,7 @@

Method Details

}, }, "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "iconEmoji": "A String", # Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon. "index": 42, # The zero-based index of the tab within the parent. "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index 890b44a852..959bc1c7ad 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -698,7 +698,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -808,7 +808,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1876,7 +1876,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1986,7 +1986,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index 3c27c54f16..dc213bcf41 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -289,7 +289,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -399,7 +399,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 96b46610d9..2dcc74d697 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -792,7 +792,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -902,7 +902,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1970,7 +1970,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2080,7 +2080,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html index c41e627363..ff35d8bb75 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html @@ -463,7 +463,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -573,7 +573,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 117458d4b7..6e3619b2d2 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -769,7 +769,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -879,7 +879,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1903,7 +1903,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2013,7 +2013,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3141,7 +3141,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3251,7 +3251,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index 2ef7b0856b..d3513dfa50 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -295,7 +295,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -405,7 +405,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1471,7 +1471,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1581,7 +1581,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 2b6649d54c..7152de3f67 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -932,7 +932,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1042,7 +1042,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2066,7 +2066,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2176,7 +2176,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3304,7 +3304,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3414,7 +3414,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, + "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index eccf95d467..8fcac1428d 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -408,27 +408,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -437,8 +437,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index 3411ac555f..7f76083ca2 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -350,27 +350,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -379,8 +379,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -661,27 +661,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -690,8 +690,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -965,27 +965,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -994,8 +994,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -1279,27 +1279,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -1308,8 +1308,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -1714,27 +1714,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -1743,8 +1743,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -2065,27 +2065,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -2094,8 +2094,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -2552,27 +2552,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -2581,8 +2581,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. @@ -2867,27 +2867,27 @@

Method Details

"A String", ], "permissions": [ # Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -2896,8 +2896,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], "properties": { # A collection of arbitrary key-value pairs which are visible to all apps. diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html index 07ae86babc..452bd0111d 100644 --- a/docs/dyn/drive_v3.permissions.html +++ b/docs/dyn/drive_v3.permissions.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

create(fileId, body=None, emailMessage=None, enforceExpansiveAccess=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmail=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

-

Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

+

Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.

delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

-

Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

+

Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.

get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

-

Gets a permission by ID.

+

Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).

list(fileId, includePermissionsForView=None, pageSize=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)

-

Lists a file's or shared drive's permissions.

+

Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).

list_next()

Retrieves the next page of results.

update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)

-

Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

+

Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.

Method Details

close() @@ -103,34 +103,34 @@

Method Details

create(fileId, body=None, emailMessage=None, enforceExpansiveAccess=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmail=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None) -
Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
+  
Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.
 
 Args:
   fileId: string, The ID of the file or shared drive. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
+{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
   "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
-  "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
-  "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
+  "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.
+  "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present.
   "domain": "A String", # The domain to which this permission refers.
   "emailAddress": "A String", # The email address of the user or group to which this permission refers.
   "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
-  "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
-  "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
+  "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.
+  "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it.
   "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
-  "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
-  "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
+  "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.
+  "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item.
     {
       "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
       "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
-      "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
-      "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
+      "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member`
+      "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
     },
   ],
   "photoLink": "A String", # Output only. A link to the user's profile photo, if available.
-  "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
+  "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
   "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
     {
       "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
@@ -139,19 +139,19 @@ 

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). } emailMessage: string, A plain text custom message to include in the notification email. enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. enforceSingleParent: boolean, Deprecated: See `moveToNewOwnersRoot` for details. - moveToNewOwnersRoot: boolean, This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed. + moveToNewOwnersRoot: boolean, This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed. sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. - transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. + transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file). + useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -160,27 +160,27 @@

Method Details

Returns: An object of the form: - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -189,14 +189,14 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }
delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None) -
Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
+  
Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.
 
 Args:
   fileId: string, The ID of the file or shared drive. (required)
@@ -204,7 +204,7 @@ 

Method Details

enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. - useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. + useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -214,14 +214,14 @@

Method Details

get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None) -
Gets a permission by ID.
+  
Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).
 
 Args:
   fileId: string, The ID of the file. (required)
   permissionId: string, The ID of the permission. (required)
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
-  useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
+  useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -230,27 +230,27 @@ 

Method Details

Returns: An object of the form: - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -259,23 +259,23 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }
list(fileId, includePermissionsForView=None, pageSize=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None) -
Lists a file's or shared drive's permissions.
+  
Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).
 
 Args:
   fileId: string, The ID of the file or shared drive. (required)
-  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
+  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
   pageSize: integer, The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
-  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
-  useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
+  useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -287,28 +287,28 @@ 

Method Details

{ # A list of permissions for a file. "kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string `"drive#permissionList"`. "nextPageToken": "A String", # The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. - "permissions": [ # The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + "permissions": [ # The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -317,8 +317,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }, ], }
@@ -340,7 +340,7 @@

Method Details

update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None) -
Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
+  
Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.
 
 Args:
   fileId: string, The ID of the file or shared drive. (required)
@@ -348,27 +348,27 @@ 

Method Details

body: object, The request body. The object takes the form of: -{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. +{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -377,16 +377,16 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). } enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. - transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. + transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file). + useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -395,27 +395,27 @@

Method Details

Returns: An object of the form: - { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. - "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. + "displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. "domain": "A String", # The domain to which this permission refers. "emailAddress": "A String", # The email address of the user or group to which this permission refers. "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future - "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. - "inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it. + "id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. + "inheritedPermissionsDisabled": True or False, # When `true`, only organizers, owners, and users with permissions added directly on the item can access it. "kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. - "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or are directly on this item. { "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. - "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` - "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "permissionType": "A String", # Output only. The permission type for this user. Supported values include: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). }, ], "photoLink": "A String", # Output only. A link to the user's profile photo, if available. - "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` + "role": "A String", # The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). "teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead. { "inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead. @@ -424,8 +424,8 @@

Method Details

"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. + "type": "A String", # The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). }
diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html index 9657a774eb..66da019289 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html @@ -76,7 +76,10 @@

Firebase App Distribution API

Instance Methods

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

-

Delete test cases.

+

Deletes multiple test cases.

+

+ batchUpdate(parent, body=None, x__xgafv=None)

+

Updates multiple test cases.

close()

Close httplib2 connections.

@@ -101,14 +104,14 @@

Instance Methods

Method Details

batchDelete(parent, body=None, x__xgafv=None) -
Delete test cases.
+  
Deletes multiple test cases.
 
 Args:
-  parent: string, Required. The parent resource where these test cases will be deleted. Format: `projects/{project_number}/apps/{app_id}` (required)
+  parent: string, Required. The parent resource of the test cases being deleted. Format: `projects/{project_number}/apps/{app_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The request message for `DeleteTestCase`.
+{ # The request message for `BatchDeleteTestCase`.
   "names": [ # Required. The name of the test cases to delete. A maximum number of 1000 test cases can be deleted in one batch Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
     "A String",
   ],
@@ -126,6 +129,77 @@ 

Method Details

}
+
+ batchUpdate(parent, body=None, x__xgafv=None) +
Updates multiple test cases.
+
+Args:
+  parent: string, Required. The parent resource of the test cases being updated. Format: `projects/{project_number}/apps/{app_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for `BatchUpdateTestCase`.
+  "requests": [ # Required. The update requests. A maximum number of 1000 test cases can be updated in one batch
+    { # The request message for `UpdateTestCase`.
+      "allowMissing": True or False, # Optional. If set to true, and the test case is not found, a new test case will be created.
+      "testCase": { # AI test cases # Required. The test case to update. The test case's `name` field is used to identify the test case to update. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
+        "aiInstructions": { # Optional. Instructions for AI driven test.
+          "steps": [ # Required. Steps to be accomplished by the AI
+            { # A step to be accomplished by the AI
+              "assertion": "A String", # An assertion to be checked by the AI
+              "goal": "A String", # A goal to be accomplished by the AI
+              "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
+              "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
+              "testCase": "A String", # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
+            },
+          ],
+        },
+        "createTime": "A String", # Output only. Timestamp when the test case was created
+        "dependentTestCases": [ # Output only. Other test cases that depend on this test case as a prerequisite.
+          "A String",
+        ],
+        "displayName": "A String", # Required. Display name of the test case.
+        "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
+        "prerequisiteTestCase": "A String", # Optional. Test case that must be run before this test case.
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for `BatchUpdateTestCase`.
+  "testCases": [ # The updated test cases.
+    { # AI test cases
+      "aiInstructions": { # Optional. Instructions for AI driven test.
+        "steps": [ # Required. Steps to be accomplished by the AI
+          { # A step to be accomplished by the AI
+            "assertion": "A String", # An assertion to be checked by the AI
+            "goal": "A String", # A goal to be accomplished by the AI
+            "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
+            "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
+            "testCase": "A String", # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
+          },
+        ],
+      },
+      "createTime": "A String", # Output only. Timestamp when the test case was created
+      "dependentTestCases": [ # Output only. Other test cases that depend on this test case as a prerequisite.
+        "A String",
+      ],
+      "displayName": "A String", # Required. Display name of the test case.
+      "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
+      "prerequisiteTestCase": "A String", # Optional. Test case that must be run before this test case.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 151935374a..89fef8cc8a 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -172,6 +172,11 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. @@ -644,6 +649,11 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. @@ -1383,6 +1393,11 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.html b/docs/dyn/iam_v1.locations.workforcePools.providers.html index bc0858b8d1..82878aa876 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.html @@ -188,6 +188,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, + "scimUsage": "A String", # Optional. Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. } @@ -330,6 +331,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, + "scimUsage": "A String", # Optional. Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. }
@@ -414,6 +416,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, + "scimUsage": "A String", # Optional. Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. }, ], @@ -503,6 +506,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, + "scimUsage": "A String", # Optional. Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. } diff --git a/docs/dyn/iap_v1.v1.html b/docs/dyn/iap_v1.v1.html index c8e9d4bd3a..16154e1af5 100644 --- a/docs/dyn/iap_v1.v1.html +++ b/docs/dyn/iap_v1.v1.html @@ -199,7 +199,7 @@

Method Details

"labels": { # The service defined labels of the resource on which the conditions will be evaluated. The semantics - including the key names - are vague to IAM. If the effective condition has a reference to a `resource.labels[foo]` construct, IAM consults with this map to retrieve the values associated with `foo` key for Conditions evaluation. If the provided key is not found in the labels map, the condition would evaluate to false. This field is in limited use. If your intended use case is not expected to express resource.labels attribute in IAM Conditions, leave this field empty. Before planning on using this attribute please: * Read go/iam-conditions-labels-comm and ensure your service can meet the data availability and management requirements. * Talk to iam-conditions-eng@ about your use case. "a_key": "A String", }, - "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - If unset or empty, the location of authorization is used as the target location. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. + "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - Must not be empty for services in-scope for Trust Boundaries. Once Trust Boundaries is GA, empty values will cause the request to be rejected if customers enforce Trust Boundaries on the parent CRM nodes. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. "A String", ], "name": "A String", # The **relative** name of the resource, which is the URI path of the resource without the leading "/". See https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name for examples used by other GCP Services. This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field. @@ -403,7 +403,7 @@

Method Details

"labels": { # The service defined labels of the resource on which the conditions will be evaluated. The semantics - including the key names - are vague to IAM. If the effective condition has a reference to a `resource.labels[foo]` construct, IAM consults with this map to retrieve the values associated with `foo` key for Conditions evaluation. If the provided key is not found in the labels map, the condition would evaluate to false. This field is in limited use. If your intended use case is not expected to express resource.labels attribute in IAM Conditions, leave this field empty. Before planning on using this attribute please: * Read go/iam-conditions-labels-comm and ensure your service can meet the data availability and management requirements. * Talk to iam-conditions-eng@ about your use case. "a_key": "A String", }, - "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - If unset or empty, the location of authorization is used as the target location. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. + "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - Must not be empty for services in-scope for Trust Boundaries. Once Trust Boundaries is GA, empty values will cause the request to be rejected if customers enforce Trust Boundaries on the parent CRM nodes. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. "A String", ], "name": "A String", # The **relative** name of the resource, which is the URI path of the resource without the leading "/". See https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name for examples used by other GCP Services. This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field. @@ -518,7 +518,7 @@

Method Details

"labels": { # The service defined labels of the resource on which the conditions will be evaluated. The semantics - including the key names - are vague to IAM. If the effective condition has a reference to a `resource.labels[foo]` construct, IAM consults with this map to retrieve the values associated with `foo` key for Conditions evaluation. If the provided key is not found in the labels map, the condition would evaluate to false. This field is in limited use. If your intended use case is not expected to express resource.labels attribute in IAM Conditions, leave this field empty. Before planning on using this attribute please: * Read go/iam-conditions-labels-comm and ensure your service can meet the data availability and management requirements. * Talk to iam-conditions-eng@ about your use case. "a_key": "A String", }, - "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - If unset or empty, the location of authorization is used as the target location. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. + "locations": [ # The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - Must not be empty for services in-scope for Trust Boundaries. Once Trust Boundaries is GA, empty values will cause the request to be rejected if customers enforce Trust Boundaries on the parent CRM nodes. - For global resources: use a single value of "global". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., ["us-east1", "us-west1"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. "A String", ], "name": "A String", # The **relative** name of the resource, which is the URI path of the resource without the leading "/". See https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name for examples used by other GCP Services. This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index b86eb94371..e99387945a 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -196,6 +196,7 @@ ## bigquerydatapolicy * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/bigquerydatapolicy_v1.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/bigquerydatapolicy_v2.html) ## bigquerydatatransfer @@ -443,6 +444,7 @@ ## dataform +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/dataform_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/dataform_v1beta1.html) diff --git a/docs/dyn/jobs_v3.projects.companies.html b/docs/dyn/jobs_v3.projects.companies.html index 90f6d1f394..10eb16ebe6 100644 --- a/docs/dyn/jobs_v3.projects.companies.html +++ b/docs/dyn/jobs_v3.projects.companies.html @@ -120,7 +120,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -173,7 +173,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -250,7 +250,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -314,7 +314,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -389,7 +389,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -443,7 +443,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/jobs_v3.projects.jobs.html b/docs/dyn/jobs_v3.projects.jobs.html index 51aaed7d47..5fb6a1ee99 100644 --- a/docs/dyn/jobs_v3.projects.jobs.html +++ b/docs/dyn/jobs_v3.projects.jobs.html @@ -243,7 +243,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -395,7 +395,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -571,7 +571,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -741,7 +741,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -915,7 +915,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1068,7 +1068,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1318,7 +1318,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1347,7 +1347,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1460,7 +1460,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1725,7 +1725,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1754,7 +1754,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1867,7 +1867,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/jobs_v3p1beta1.projects.companies.html b/docs/dyn/jobs_v3p1beta1.projects.companies.html index f27fc37657..cf538324b9 100644 --- a/docs/dyn/jobs_v3p1beta1.projects.companies.html +++ b/docs/dyn/jobs_v3p1beta1.projects.companies.html @@ -120,7 +120,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -173,7 +173,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -250,7 +250,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -314,7 +314,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -389,7 +389,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -443,7 +443,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/jobs_v3p1beta1.projects.jobs.html b/docs/dyn/jobs_v3p1beta1.projects.jobs.html index 600b98050b..6e618df7ae 100644 --- a/docs/dyn/jobs_v3p1beta1.projects.jobs.html +++ b/docs/dyn/jobs_v3p1beta1.projects.jobs.html @@ -243,7 +243,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -395,7 +395,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -571,7 +571,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -741,7 +741,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -915,7 +915,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1068,7 +1068,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1338,7 +1338,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1367,7 +1367,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1480,7 +1480,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1765,7 +1765,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1794,7 +1794,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1907,7 +1907,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/jobs_v4.projects.tenants.companies.html b/docs/dyn/jobs_v4.projects.tenants.companies.html index c20960a1e7..91eaf67a7e 100644 --- a/docs/dyn/jobs_v4.projects.tenants.companies.html +++ b/docs/dyn/jobs_v4.projects.tenants.companies.html @@ -119,7 +119,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -171,7 +171,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -248,7 +248,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -312,7 +312,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -386,7 +386,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -439,7 +439,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/jobs_v4.projects.tenants.jobs.html b/docs/dyn/jobs_v4.projects.tenants.jobs.html index 2b3a7277be..c2f0971b36 100644 --- a/docs/dyn/jobs_v4.projects.tenants.jobs.html +++ b/docs/dyn/jobs_v4.projects.tenants.jobs.html @@ -221,7 +221,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -451,7 +451,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -641,7 +641,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -793,7 +793,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -970,7 +970,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1141,7 +1141,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1315,7 +1315,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1468,7 +1468,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1662,7 +1662,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1691,7 +1691,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1805,7 +1805,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2015,7 +2015,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2044,7 +2044,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2158,7 +2158,7 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "locationType": "A String", # The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.connectors.html b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.connectors.html index 5299ff2f7e..d4e6c5cc3e 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.connectors.html +++ b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.connectors.html @@ -128,9 +128,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, } @@ -149,9 +150,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, }
@@ -194,9 +196,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, }
@@ -225,9 +228,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, }, ], @@ -264,9 +268,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, } @@ -285,9 +290,10 @@

Method Details

}, "name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} "state": "A String", # Output only. The current state of the connector. - "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector. + "taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively. # Optional. Restarts the individual tasks of a Connector. "maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. "minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + "taskRetryDisabled": True or False, # Optional. If true, task retry is disabled. }, }
diff --git a/docs/dyn/managedkafka_v1.projects.locations.operations.html b/docs/dyn/managedkafka_v1.projects.locations.operations.html index c77a12d792..3f67a4cc08 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.operations.html +++ b/docs/dyn/managedkafka_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.html b/docs/dyn/networkconnectivity_v1.projects.locations.html index c27c349537..10b57362c3 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.html @@ -104,11 +104,6 @@

Instance Methods

Returns the regionalEndpoints Resource.

-

- remoteTransportProfiles() -

-

Returns the remoteTransportProfiles Resource.

-

serviceClasses()

@@ -134,11 +129,6 @@

Instance Methods

Returns the spokes Resource.

-

- transports() -

-

Returns the transports Resource.

-

checkConsumerConfig(location, body=None, x__xgafv=None)

CheckConsumerConfig validates the consumer network and project for potential PSC connection creation. This method performs several checks, including: - Validating the existence and permissions of the service class. - Ensuring the consumer network exists and is accessible. - Verifying XPN relationships if applicable. - Checking for compatible IP versions between the consumer network and the requested version. This method performs a dynamic IAM check for the `networkconnectivity.serviceClasses.use` permission on the service class resource in the Prepare phase.

diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html index 07117f5990..70cd243cf7 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html @@ -139,6 +139,19 @@

Method Details

], "consumerPscConnections": [ # Output only. PSC connection details on consumer side. { # PSC connection details on consumer side. + "dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection. + "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 details if the state is CREATE_FAILED or DELETE_FAILED. + "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. + }, + "fqdn": "A String", # Output only. The fully qualified domain name of the DNS record. + "state": "A String", # Output only. The current state of DNS automation. + }, "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 most recent error during operating this connection. "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. @@ -182,6 +195,11 @@

Method Details

"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names "producerPscConfigs": [ # The PSC configurations on producer side. { # The PSC configurations on producer side. + "automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection. + "dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal." + "hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1" + "ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used. + }, "serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}. }, ], @@ -293,6 +311,19 @@

Method Details

], "consumerPscConnections": [ # Output only. PSC connection details on consumer side. { # PSC connection details on consumer side. + "dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection. + "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 details if the state is CREATE_FAILED or DELETE_FAILED. + "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. + }, + "fqdn": "A String", # Output only. The fully qualified domain name of the DNS record. + "state": "A String", # Output only. The current state of DNS automation. + }, "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 most recent error during operating this connection. "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. @@ -336,6 +367,11 @@

Method Details

"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names "producerPscConfigs": [ # The PSC configurations on producer side. { # The PSC configurations on producer side. + "automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection. + "dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal." + "hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1" + "ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used. + }, "serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}. }, ], @@ -435,6 +471,19 @@

Method Details

], "consumerPscConnections": [ # Output only. PSC connection details on consumer side. { # PSC connection details on consumer side. + "dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection. + "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 details if the state is CREATE_FAILED or DELETE_FAILED. + "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. + }, + "fqdn": "A String", # Output only. The fully qualified domain name of the DNS record. + "state": "A String", # Output only. The current state of DNS automation. + }, "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 most recent error during operating this connection. "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. @@ -478,6 +527,11 @@

Method Details

"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names "producerPscConfigs": [ # The PSC configurations on producer side. { # The PSC configurations on producer side. + "automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection. + "dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal." + "hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1" + "ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used. + }, "serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}. }, ], @@ -536,6 +590,19 @@

Method Details

], "consumerPscConnections": [ # Output only. PSC connection details on consumer side. { # PSC connection details on consumer side. + "dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection. + "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 details if the state is CREATE_FAILED or DELETE_FAILED. + "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. + }, + "fqdn": "A String", # Output only. The fully qualified domain name of the DNS record. + "state": "A String", # Output only. The current state of DNS automation. + }, "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 most recent error during operating this connection. "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. @@ -579,6 +646,11 @@

Method Details

"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names "producerPscConfigs": [ # The PSC configurations on producer side. { # The PSC configurations on producer side. + "automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection. + "dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal." + "hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1" + "ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used. + }, "serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}. }, ], diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html index edd48d7b40..c79ec58898 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html @@ -183,7 +183,7 @@

Method Details

"updateTime": "A String", # Output only. Time when the ServiceConnectionPolicy was updated. } - autoSubnetworkConfig_allocRangeSpace: string, Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. + autoSubnetworkConfig_allocRangeSpace: string, Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. (repeated) autoSubnetworkConfig_ipStack: string, Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used. Allowed values SUBNET_IP_STACK_UNSPECIFIED - Default value. Will create an IPV4_ONLY subnetwork by default. diff --git a/docs/dyn/notebooks_v1.projects.locations.html b/docs/dyn/notebooks_v1.projects.locations.html index 08ae60105a..88d6a0bd66 100644 --- a/docs/dyn/notebooks_v1.projects.locations.html +++ b/docs/dyn/notebooks_v1.projects.locations.html @@ -155,7 +155,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/notebooks_v1.projects.locations.operations.html b/docs/dyn/notebooks_v1.projects.locations.operations.html index 84e0fb3cb7..bcd27b3b3c 100644 --- a/docs/dyn/notebooks_v1.projects.locations.operations.html +++ b/docs/dyn/notebooks_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/notebooks_v2.projects.locations.html b/docs/dyn/notebooks_v2.projects.locations.html index ef046ef35f..c00bf36977 100644 --- a/docs/dyn/notebooks_v2.projects.locations.html +++ b/docs/dyn/notebooks_v2.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index 42dd5125eb..955ac6847c 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -246,6 +246,9 @@

Method Details

"diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Input only. Indicates the type of the disk. "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. + "A String", + ], }, ], "disablePublicIp": True or False, # Optional. If true, no external IP will be assigned to this VM instance. @@ -311,7 +314,7 @@

Method Details

"labels": { # Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. "a_key": "A String", }, - "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` + "name": "A String", # Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. @@ -525,6 +528,9 @@

Method Details

"diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Input only. Indicates the type of the disk. "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. + "A String", + ], }, ], "disablePublicIp": True or False, # Optional. If true, no external IP will be assigned to this VM instance. @@ -590,7 +596,7 @@

Method Details

"labels": { # Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. "a_key": "A String", }, - "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` + "name": "A String", # Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. @@ -737,6 +743,9 @@

Method Details

"diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Input only. Indicates the type of the disk. "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. + "A String", + ], }, ], "disablePublicIp": True or False, # Optional. If true, no external IP will be assigned to this VM instance. @@ -802,7 +811,7 @@

Method Details

"labels": { # Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. "a_key": "A String", }, - "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` + "name": "A String", # Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. @@ -850,7 +859,7 @@

Method Details

UpdateInstance updates an Instance.
 
 Args:
-  name: string, Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
+  name: string, Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -887,6 +896,9 @@ 

Method Details

"diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Input only. Indicates the type of the disk. "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. + "A String", + ], }, ], "disablePublicIp": True or False, # Optional. If true, no external IP will be assigned to this VM instance. @@ -952,7 +964,7 @@

Method Details

"labels": { # Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. "a_key": "A String", }, - "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` + "name": "A String", # Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. @@ -1116,6 +1128,9 @@

Method Details

"diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Input only. Indicates the type of the disk. "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. + "A String", + ], }, } diff --git a/docs/dyn/notebooks_v2.projects.locations.operations.html b/docs/dyn/notebooks_v2.projects.locations.operations.html index 7b0acbde34..c445fc8c4e 100644 --- a/docs/dyn/notebooks_v2.projects.locations.operations.html +++ b/docs/dyn/notebooks_v2.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.databases.html b/docs/dyn/oracledatabase_v1.projects.locations.databases.html index 183bf665e8..b60e36cd62 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.databases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.databases.html @@ -151,7 +151,7 @@

Method Details

Args: parent: string, Required. The parent resource name in the following format: projects/{project}/locations/{region} (required) filter: string, Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"` - pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbSystemInitialStorageSizes.html b/docs/dyn/oracledatabase_v1.projects.locations.dbSystemInitialStorageSizes.html index 9e05b44808..013fbfff64 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbSystemInitialStorageSizes.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbSystemInitialStorageSizes.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location} (required) - pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbVersions.html b/docs/dyn/oracledatabase_v1.projects.locations.dbVersions.html index 28fb90b9fa..3f09f7d354 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbVersions.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbVersions.html @@ -96,7 +96,7 @@

Method Details

Args: parent: string, Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location} (required) filter: string, Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape} AND storage_management = {storage_management}`. If no filter is provided, all DbVersions will be returned. - pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.dbNodes.html b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.dbNodes.html new file mode 100644 index 0000000000..b39c9d9604 --- /dev/null +++ b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.dbNodes.html @@ -0,0 +1,143 @@ + + + +

Oracle Database@Google Cloud API . projects . locations . exadbVmClusters . dbNodes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the database nodes of a VM Cluster.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the database nodes of a VM Cluster.
+
+Args:
+  parent: string, Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. . (required)
+  pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A token identifying a page of results the node should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for `DbNode.List`.
+  "dbNodes": [ # The list of DB Nodes
+    { # Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/
+      "name": "A String", # Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}
+      "properties": { # Various properties and settings associated with Db node. # Optional. Various properties of the database node.
+        "createTime": "A String", # Output only. The date and time that the database node was created.
+        "dbNodeStorageSizeGb": 42, # Optional. Local storage per database node.
+        "dbServerOcid": "A String", # Optional. Database server OCID.
+        "hostname": "A String", # Optional. DNS
+        "memorySizeGb": 42, # Memory allocated in GBs.
+        "ocid": "A String", # Output only. OCID of database node.
+        "ocpuCount": 42, # Optional. OCPU count per database node.
+        "state": "A String", # Output only. State of the database node.
+        "totalCpuCoreCount": 42, # Total CPU core count of the database node.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the node should return.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html index ef83c2a8bf..8e3ed7d723 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html @@ -74,6 +74,11 @@

Oracle Database@Google Cloud API . projects . locations . exadbVmClusters

Instance Methods

+

+ dbNodes() +

+

Returns the dbNodes Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index bed09dec88..1455f62dbb 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -74,6 +74,11 @@

Payments Reseller Subscription API . partners . subscriptions

Instance Methods

+

+ lineItems() +

+

Returns the lineItems Resource.

+

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

Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.

@@ -93,7 +98,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets a subscription by id. It should be called directly by the partner using service accounts.

- provision(parent, body=None, subscriptionId=None, x__xgafv=None)

+ provision(parent, body=None, cycleOptions_initialCycleDuration_count=None, cycleOptions_initialCycleDuration_unit=None, subscriptionId=None, x__xgafv=None)

Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts.

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

@@ -911,7 +916,7 @@

Method Details

- provision(parent, body=None, subscriptionId=None, x__xgafv=None) + provision(parent, body=None, cycleOptions_initialCycleDuration_count=None, cycleOptions_initialCycleDuration_unit=None, subscriptionId=None, x__xgafv=None)
Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts.
 
 Args:
@@ -1054,6 +1059,13 @@ 

Method Details

}, } + cycleOptions_initialCycleDuration_count: integer, number of duration units to be included. + cycleOptions_initialCycleDuration_unit: string, The unit used for the duration + Allowed values + UNIT_UNSPECIFIED - Default value, reserved as an invalid or an unexpected value. + MONTH - Unit of a calendar month. + DAY - Unit of a day. + HOUR - Unit of an hour. It is used for testing. subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. x__xgafv: string, V1 error format. Allowed values @@ -1209,6 +1221,12 @@

Method Details

The object takes the form of: { # Request to resume a suspended subscription. + "cycleOptions": { # The cycle options when starting and resuming a subscription. # Optional. The cycle options for the subscription. + "initialCycleDuration": { # Describes the length of a period of a time. # Optional. The duration of the initial cycle. Only `DAY` is supported. If set, Google will start the subscription with this initial cycle duration starting at the request time (see available methods below). A prorated charge will be applied. This option is available to the following methods: - partners.subscriptions.provision - partners.subscriptions.resume - partners.userSessions.generate + "count": 42, # number of duration units to be included. + "unit": "A String", # The unit used for the duration + }, + }, } x__xgafv: string, V1 error format. diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html new file mode 100644 index 0000000000..838fd45ffc --- /dev/null +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html @@ -0,0 +1,260 @@ + + + +

Payments Reseller Subscription API . partners . subscriptions . lineItems

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a line item of a subscription. It should be autenticated with a service account.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a line item of a subscription. It should be autenticated with a service account.
+
+Args:
+  name: string, Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Individual line item definition of a subscription.
+  "amount": { # Describes the amount unit including the currency code. # Output only. The price of the product/service in this line item. The amount could be the wholesale price, or it can include a cost of sale based on the contract.
+    "amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
+    "currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
+  },
+  "bundleDetails": { # The bundle details for a line item corresponding to a hard bundle. # Output only. The bundle details for the line item. Only populated if the line item corresponds to a hard bundle.
+    "bundleElementDetails": [ # Output only. The details for each element in the hard bundle.
+      { # The details for an element in the hard bundle.
+        "product": "A String", # Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'.
+        "userAccountLinkedTime": "A String", # Output only. The time when this product is linked to an end user.
+      },
+    ],
+  },
+  "description": "A String", # Output only. Description of this line item.
+  "finiteBillingCycleDetails": { # Details for a subscriptiin line item with finite billing cycles. # Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely. Used only with LINE_ITEM_RECURRENCE_TYPE_PERIODIC.
+    "billingCycleCountLimit": "A String", # Required. The number of a subscription line item billing cycles after which billing will stop automatically.
+  },
+  "lineItemFreeTrialEndTime": "A String", # Output only. The free trial end time will be populated after the line item is successfully processed. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
+  "lineItemIndex": 42, # Output only. A unique index of the subscription line item.
+  "lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - an introductory pricing promotion. - a free trial promotion. This feature is not enabled. If used, the request will be rejected. When used as input in Create or Provision API, specify its resource name only.
+    { # Describes the spec for one promotion.
+      "freeTrialDuration": { # Describes the length of a period of a time. # Output only. The duration of the free trial if the promotion is of type FREE_TRIAL.
+        "count": 42, # number of duration units to be included.
+        "unit": "A String", # The unit used for the duration
+      },
+      "introductoryPricingDetails": { # The details of a introductory pricing promotion. # Output only. The details of the introductory pricing spec if the promotion is of type INTRODUCTORY_PRICING.
+        "introductoryPricingSpecs": [ # Output only. Specifies the introductory pricing periods.
+          { # The duration of an introductory pricing promotion.
+            "discountAmount": { # Describes the amount unit including the currency code. # Output only. The discount amount. The value is positive.
+              "amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
+              "currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
+            },
+            "discountRatioMicros": "A String", # Output only. The discount percentage in micros. For example, 50,000 represents 5%.
+            "recurrenceCount": 42, # Output only. The duration of an introductory offer in billing cycles.
+            "regionCode": "A String", # Output only. 2-letter ISO region code where the product is available in. Ex. "US".
+          },
+        ],
+      },
+      "promotion": "A String", # Required. Promotion resource name that identifies a promotion. The format is 'partners/{partner_id}/promotions/{promotion_id}'.
+      "type": "A String", # Output only. The type of the promotion for the spec.
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}
+  "oneTimeRecurrenceDetails": { # Details for a ONE_TIME recurrence line item. # Output only. Details only set for a ONE_TIME recurrence line item.
+    "servicePeriod": { # A description of what time period or moment in time the product or service is being delivered over. # Output only. The service period of the ONE_TIME line item.
+      "endTime": "A String", # Optional. The end time of the service period. Time is exclusive.
+      "startTime": "A String", # Required. The start time of the service period. Time is inclusive.
+    },
+  },
+  "product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+  "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+    "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products.
+      "attachedToGoogleStructure": True or False, # Output only. This identifies whether the subscription is attached to a Google Home structure.
+      "googleStructureId": "A String", # Optional. Structure identifier on Google side.
+      "partnerStructureId": "A String", # Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.
+    },
+    "googleOnePayload": { # Payload specific to Google One products. # Product-specific payloads. Payload specific to Google One products.
+      "campaigns": [ # Campaign attributed to sales of this subscription.
+        "A String",
+      ],
+      "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+      "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+      "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+    },
+    "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+      "accessEndTime": "A String", # Output only. The access expiration time for this line item.
+      "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+        "A String",
+      ],
+      "partnerPlanType": "A String", # Optional. Specifies the plan type offered to the end user by the partner.
+    },
+  },
+  "recurrenceType": "A String", # Output only. The recurrence type of the line item.
+  "state": "A String", # Output only. The state of the line item.
+}
+
+  updateMask: string, Required. The list of fields to update. Only a limited set of fields can be updated. The allowed fields are the following: - `product_payload.googleHomePayload.googleStructureId`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Individual line item definition of a subscription.
+  "amount": { # Describes the amount unit including the currency code. # Output only. The price of the product/service in this line item. The amount could be the wholesale price, or it can include a cost of sale based on the contract.
+    "amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
+    "currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
+  },
+  "bundleDetails": { # The bundle details for a line item corresponding to a hard bundle. # Output only. The bundle details for the line item. Only populated if the line item corresponds to a hard bundle.
+    "bundleElementDetails": [ # Output only. The details for each element in the hard bundle.
+      { # The details for an element in the hard bundle.
+        "product": "A String", # Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'.
+        "userAccountLinkedTime": "A String", # Output only. The time when this product is linked to an end user.
+      },
+    ],
+  },
+  "description": "A String", # Output only. Description of this line item.
+  "finiteBillingCycleDetails": { # Details for a subscriptiin line item with finite billing cycles. # Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely. Used only with LINE_ITEM_RECURRENCE_TYPE_PERIODIC.
+    "billingCycleCountLimit": "A String", # Required. The number of a subscription line item billing cycles after which billing will stop automatically.
+  },
+  "lineItemFreeTrialEndTime": "A String", # Output only. The free trial end time will be populated after the line item is successfully processed. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
+  "lineItemIndex": 42, # Output only. A unique index of the subscription line item.
+  "lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - an introductory pricing promotion. - a free trial promotion. This feature is not enabled. If used, the request will be rejected. When used as input in Create or Provision API, specify its resource name only.
+    { # Describes the spec for one promotion.
+      "freeTrialDuration": { # Describes the length of a period of a time. # Output only. The duration of the free trial if the promotion is of type FREE_TRIAL.
+        "count": 42, # number of duration units to be included.
+        "unit": "A String", # The unit used for the duration
+      },
+      "introductoryPricingDetails": { # The details of a introductory pricing promotion. # Output only. The details of the introductory pricing spec if the promotion is of type INTRODUCTORY_PRICING.
+        "introductoryPricingSpecs": [ # Output only. Specifies the introductory pricing periods.
+          { # The duration of an introductory pricing promotion.
+            "discountAmount": { # Describes the amount unit including the currency code. # Output only. The discount amount. The value is positive.
+              "amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
+              "currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
+            },
+            "discountRatioMicros": "A String", # Output only. The discount percentage in micros. For example, 50,000 represents 5%.
+            "recurrenceCount": 42, # Output only. The duration of an introductory offer in billing cycles.
+            "regionCode": "A String", # Output only. 2-letter ISO region code where the product is available in. Ex. "US".
+          },
+        ],
+      },
+      "promotion": "A String", # Required. Promotion resource name that identifies a promotion. The format is 'partners/{partner_id}/promotions/{promotion_id}'.
+      "type": "A String", # Output only. The type of the promotion for the spec.
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}
+  "oneTimeRecurrenceDetails": { # Details for a ONE_TIME recurrence line item. # Output only. Details only set for a ONE_TIME recurrence line item.
+    "servicePeriod": { # A description of what time period or moment in time the product or service is being delivered over. # Output only. The service period of the ONE_TIME line item.
+      "endTime": "A String", # Optional. The end time of the service period. Time is exclusive.
+      "startTime": "A String", # Required. The start time of the service period. Time is inclusive.
+    },
+  },
+  "product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+  "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+    "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products.
+      "attachedToGoogleStructure": True or False, # Output only. This identifies whether the subscription is attached to a Google Home structure.
+      "googleStructureId": "A String", # Optional. Structure identifier on Google side.
+      "partnerStructureId": "A String", # Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.
+    },
+    "googleOnePayload": { # Payload specific to Google One products. # Product-specific payloads. Payload specific to Google One products.
+      "campaigns": [ # Campaign attributed to sales of this subscription.
+        "A String",
+      ],
+      "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+      "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+      "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+    },
+    "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+      "accessEndTime": "A String", # Output only. The access expiration time for this line item.
+      "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+        "A String",
+      ],
+      "partnerPlanType": "A String", # Optional. Specifies the plan type offered to the end user by the partner.
+    },
+  },
+  "recurrenceType": "A String", # Output only. The recurrence type of the line item.
+  "state": "A String", # Output only. The state of the line item.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index d1e87c349c..138509b5d0 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -249,7 +249,7 @@

Method Details

], }, "userIpAddress": "A String", # Optional. The IP address in the request from the user's device related to this event. - "wafTokenAssessment": True or False, # Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key. + "wafTokenAssessment": True or False, # Optional. Flag for running Web Application Firewall (WAF) token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key. }, "firewallPolicyAssessment": { # Policy config assessment. # Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation. "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 the processing of a policy config fails, an error is populated and the firewall_policy is left empty. @@ -478,7 +478,7 @@

Method Details

], }, "userIpAddress": "A String", # Optional. The IP address in the request from the user's device related to this event. - "wafTokenAssessment": True or False, # Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key. + "wafTokenAssessment": True or False, # Optional. Flag for running Web Application Firewall (WAF) token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key. }, "firewallPolicyAssessment": { # Policy config assessment. # Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation. "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 the processing of a policy config fails, an error is populated and the firewall_policy is left empty. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index bfeec1ac9b..83e37f2934 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -190,9 +190,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -254,9 +254,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -343,9 +343,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -462,9 +462,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -598,9 +598,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -664,9 +664,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. @@ -729,9 +729,9 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, - "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF - "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. - "wafService": "A String", # Required. The WAF service that uses this key. + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). + "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. + "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced. diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html index fb73f84ab3..d86c66d811 100644 --- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html +++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.operations.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.operations.html index 4b4d2dd7f4..f41cc50d53 100644 --- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.operations.html +++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/redis_v1.projects.locations.operations.html b/docs/dyn/redis_v1.projects.locations.operations.html index 7b08b32ea6..782ca8703e 100644 --- a/docs/dyn/redis_v1.projects.locations.operations.html +++ b/docs/dyn/redis_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/redis_v1beta1.projects.locations.operations.html b/docs/dyn/redis_v1beta1.projects.locations.operations.html index e691dcda78..1e9d6e8d8b 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.operations.html +++ b/docs/dyn/redis_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html index 4b8ed14c29..0738acaf3a 100644 --- a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html +++ b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html @@ -195,6 +195,10 @@

Method Details

"a_key": "A String", }, "customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time. + "objectRetention": { # Describes options for object retention update. # Optional. Updates objects retention lock configuration. Unset values will be ignored. Set empty values to clear the retention for the object with existing `Unlocked` retention mode. Object with existing `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer to documentation in https://cloud.google.com/storage/docs/object-lock + "retainUntilTime": "A String", # Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'. + "retentionMode": "A String", # Required. The retention mode of the object. + }, }, "putObjectHold": { # Describes options to update object hold. # Changes object hold status. "eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period. @@ -331,6 +335,10 @@

Method Details

"a_key": "A String", }, "customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time. + "objectRetention": { # Describes options for object retention update. # Optional. Updates objects retention lock configuration. Unset values will be ignored. Set empty values to clear the retention for the object with existing `Unlocked` retention mode. Object with existing `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer to documentation in https://cloud.google.com/storage/docs/object-lock + "retainUntilTime": "A String", # Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'. + "retentionMode": "A String", # Required. The retention mode of the object. + }, }, "putObjectHold": { # Describes options to update object hold. # Changes object hold status. "eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period. @@ -424,6 +432,10 @@

Method Details

"a_key": "A String", }, "customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time. + "objectRetention": { # Describes options for object retention update. # Optional. Updates objects retention lock configuration. Unset values will be ignored. Set empty values to clear the retention for the object with existing `Unlocked` retention mode. Object with existing `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer to documentation in https://cloud.google.com/storage/docs/object-lock + "retainUntilTime": "A String", # Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'. + "retentionMode": "A String", # Required. The retention mode of the object. + }, }, "putObjectHold": { # Describes options to update object hold. # Changes object hold status. "eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period. diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html index 68a0f9f462..4af2c1438f 100644 --- a/docs/dyn/texttospeech_v1.text.html +++ b/docs/dyn/texttospeech_v1.text.html @@ -97,6 +97,7 @@

Method Details

{ # The top-level message sent by the client for the `SynthesizeSpeech` method. "advancedVoiceOptions": { # Used for advanced voice options. # Advanced voice options. "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency. + "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT. }, "audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio. "audioEncoding": "A String", # Required. The format of the audio byte stream. diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html index 9dfe003908..3b5411ef35 100644 --- a/docs/dyn/texttospeech_v1beta1.text.html +++ b/docs/dyn/texttospeech_v1beta1.text.html @@ -97,6 +97,7 @@

Method Details

{ # The top-level message sent by the client for the `SynthesizeSpeech` method. "advancedVoiceOptions": { # Used for advanced voice options. # Advanced voice options. "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency. + "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT. }, "audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio. "audioEncoding": "A String", # Required. The format of the audio byte stream. diff --git a/docs/dyn/vault_v1.operations.html b/docs/dyn/vault_v1.operations.html index e3136fa990..39c3910ca6 100644 --- a/docs/dyn/vault_v1.operations.html +++ b/docs/dyn/vault_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json index 0723306a09..3a679d3717 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20250912", +"revision": "20251015", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -1336,7 +1336,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", +"PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", +"PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -1380,7 +1382,9 @@ "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 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. 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." ], diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 6069cd99bb..727e53c735 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -238,6 +238,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://staging-aiplatform.us.rep.sandbox.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -2061,6 +2066,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2376,6 +2386,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2891,6 +2906,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3156,6 +3176,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3309,6 +3334,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3661,6 +3691,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3893,6 +3928,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -4236,6 +4276,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -5214,6 +5259,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -6257,6 +6307,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}:wait", @@ -6385,6 +6440,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}:wait", @@ -6813,6 +6873,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateFetchAccessToken": { +"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", +"parameterOrder": [ +"featureView" +], +"parameters": { +"featureView": { +"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+featureView}:generateFetchAccessToken", +"request": { +"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single FeatureView.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", @@ -7224,6 +7312,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}:wait", @@ -7352,6 +7445,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}:wait", @@ -8485,6 +8583,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -8638,6 +8741,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -8791,6 +8899,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -9101,6 +9214,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -9557,6 +9675,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -9929,6 +10052,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -10452,6 +10580,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -10924,6 +11057,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -11335,6 +11473,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -11591,6 +11734,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -11804,6 +11952,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -12204,6 +12357,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -12944,6 +13102,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -13201,6 +13364,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -13742,6 +13910,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -14158,6 +14331,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -14529,6 +14707,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -14682,6 +14865,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -15018,6 +15206,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -15394,6 +15587,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -15994,6 +16192,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -16268,6 +16471,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -16425,6 +16633,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -16796,6 +17009,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -17167,6 +17385,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -17483,6 +17706,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -17782,6 +18010,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -18219,6 +18452,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -18856,6 +19094,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -19238,6 +19481,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -19661,6 +19909,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -19818,6 +20071,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -20128,6 +20386,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -20435,6 +20698,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -20930,7 +21198,7 @@ } } }, -"revision": "20250926", +"revision": "20251003", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -23056,7 +23324,8 @@ "IMAGE_PROHIBITED_CONTENT", "IMAGE_RECITATION", "IMAGE_OTHER", -"UNEXPECTED_TOOL_CALL" +"UNEXPECTED_TOOL_CALL", +"NO_IMAGE" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -23074,7 +23343,8 @@ "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", -"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." +"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", +"The model was expected to generate an image, but none was generated." ], "readOnly": true, "type": "string" @@ -25249,6 +25519,13 @@ "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" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels with user-defined metadata to organize your Endpoints. 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.", +"type": "object" +}, "privateServiceConnectConfig": { "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." @@ -25336,7 +25613,7 @@ "type": "string" }, "deploymentTier": { -"description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.", +"description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.", "enum": [ "DEPLOYMENT_TIER_UNSPECIFIED", "STORAGE" @@ -25917,6 +26194,28 @@ "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", "id": "GoogleCloudAiplatformV1EnterpriseWebSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", "items": { @@ -26949,7 +27248,7 @@ "description": "Optional. Generation config." }, "model": { -"description": "Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, @@ -28660,6 +28959,15 @@ "autoScaling": { "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling", "description": "Required. Autoscaling config applied to Bigtable Instance." +}, +"bigtableMetadata": { +"$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata", +"description": "Output only. Metadata of the Bigtable instance. Output only.", +"readOnly": true +}, +"enableDirectBigtableAccess": { +"description": "Optional. It true, enable direct access to the Bigtable instance.", +"type": "boolean" } }, "type": "object" @@ -28685,6 +28993,25 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata": { +"description": "Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project.", +"id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata", +"properties": { +"instanceId": { +"description": "The Cloud Bigtable instance id.", +"type": "string" +}, +"tableId": { +"description": "The Cloud Bigtable table id.", +"type": "string" +}, +"tenantProjectId": { +"description": "Tenant project ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint": { "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", "id": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", @@ -28870,6 +29197,11 @@ "$ref": "GoogleCloudAiplatformV1FeatureViewBigQuerySource", "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore." }, +"bigtableMetadata": { +"$ref": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata", +"description": "Output only. Metadata containing information about the Cloud Bigtable.", +"readOnly": true +}, "createTime": { "description": "Output only. Timestamp when this FeatureView was created.", "format": "google-datetime", @@ -28966,6 +29298,18 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1FeatureViewBigtableMetadata": { +"description": "Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances.", +"id": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata", +"properties": { +"readAppProfile": { +"description": "Output only. The Bigtable App Profile to use for reading from Bigtable.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1FeatureViewDataKey": { "description": "Lookup key for a feature view.", "id": "GoogleCloudAiplatformV1FeatureViewDataKey", @@ -30186,7 +30530,8 @@ "BLOCKLIST", "PROHIBITED_CONTENT", "MODEL_ARMOR", -"IMAGE_SAFETY" +"IMAGE_SAFETY", +"JAILBREAK" ], "enumDescriptions": [ "The blocked reason is unspecified.", @@ -30195,7 +30540,8 @@ "The prompt was blocked because it contains a term from the terminology blocklist.", "The prompt was blocked because it contains prohibited content.", "The prompt was blocked by Model Armor.", -"The prompt was blocked because it contains content that is unsafe for image generation." +"The prompt was blocked because it contains content that is unsafe for image generation.", +"The prompt was blocked as a jailbreak attempt." ], "readOnly": true, "type": "string" @@ -30303,6 +30649,28 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest": { +"description": "Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.", +"id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse": { +"description": "Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.", +"id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse", +"properties": { +"accessToken": { +"description": "The OAuth 2.0 access token.", +"type": "string" +}, +"expireTime": { +"description": "Token expiration time. This is always set", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest": { "description": "Request message for EvaluationService.GenerateInstanceRubrics.", "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", @@ -30459,6 +30827,10 @@ "format": "float", "type": "number" }, +"imageConfig": { +"$ref": "GoogleCloudAiplatformV1ImageConfig", +"description": "Optional. Config for image generation features." +}, "logprobs": { "description": "Optional. Logit probabilities.", "format": "int32", @@ -31159,6 +31531,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ImageConfig": { +"description": "Config for image generation features.", +"id": "GoogleCloudAiplatformV1ImageConfig", +"properties": { +"aspectRatio": { +"description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ImportDataConfig": { "description": "Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.", "id": "GoogleCloudAiplatformV1ImportDataConfig", @@ -35078,6 +35461,20 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": { +"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", +"id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", +"properties": { +"speakerVoiceConfigs": { +"description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", +"items": { +"$ref": "GoogleCloudAiplatformV1SpeakerVoiceConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", "id": "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata", @@ -37593,6 +37990,26 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PreTunedModel": { +"description": "A pre-tuned model for continuous tuning.", +"id": "GoogleCloudAiplatformV1PreTunedModel", +"properties": { +"baseModel": { +"description": "Output only. The name of the base model this PreTunedModel was tuned from.", +"readOnly": true, +"type": "string" +}, +"checkpointId": { +"description": "Optional. The source checkpoint id. If not specified, the default checkpoint will be used.", +"type": "string" +}, +"tunedModelName": { +"description": "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}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { "description": "The configuration for the prebuilt speaker to use.", "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", @@ -40613,7 +41030,8 @@ false "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", -"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -40625,6 +41043,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -40637,7 +41056,8 @@ false "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", -"The harm category is image sexually explicit content." +"The harm category is image sexually explicit content.", +"The harm category is for jailbreak prompts." ], "readOnly": true, "type": "string" @@ -40756,7 +41176,8 @@ false "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", -"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -40768,6 +41189,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -40780,7 +41202,8 @@ false "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", -"The harm category is image sexually explicit content." +"The harm category is image sexually explicit content.", +"The harm category is for jailbreak prompts." ], "type": "string" }, @@ -45822,6 +46245,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SpeakerVoiceConfig": { +"description": "Configuration for a single speaker in a multi speaker setup.", +"id": "GoogleCloudAiplatformV1SpeakerVoiceConfig", +"properties": { +"speaker": { +"description": "Required. The name of the speaker. This should be the same as the speaker name used in the prompt.", +"type": "string" +}, +"voiceConfig": { +"$ref": "GoogleCloudAiplatformV1VoiceConfig", +"description": "Required. The configuration for the voice of this speaker." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SpecialistPool": { "description": "SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers. Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.", "id": "GoogleCloudAiplatformV1SpecialistPool", @@ -45916,6 +46354,10 @@ false "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", "type": "string" }, +"multiSpeakerVoiceConfig": { +"$ref": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", +"description": "The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`." +}, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1VoiceConfig", "description": "The configuration for the speaker to use." @@ -47948,6 +48390,28 @@ false "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1ToolGoogleSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [\"amazon.com\", \"facebook.com\"].", "items": { @@ -48851,7 +49315,7 @@ false "type": "string" }, "model": { -"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`", +"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`", "readOnly": true, "type": "string" } @@ -48963,6 +49427,10 @@ false "readOnly": true, "type": "string" }, +"preTunedModel": { +"$ref": "GoogleCloudAiplatformV1PreTunedModel", +"description": "The pre-tuned model for continuous tuning." +}, "serviceAccount": { "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -49016,7 +49484,7 @@ false "readOnly": true }, "tunedModelDisplayName": { -"description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.", "type": "string" }, "tuningDataStats": { @@ -49931,6 +50399,13 @@ false "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 350a1f398f..37bec44163 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -238,6 +238,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://staging-aiplatform.us.rep.sandbox.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -1708,6 +1713,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1863,6 +1873,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -2482,6 +2497,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -2797,6 +2817,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -3368,6 +3393,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -3633,6 +3663,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -3786,6 +3821,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -4138,6 +4178,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -4370,6 +4415,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -4713,6 +4763,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -4868,6 +4923,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -5932,6 +5992,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -6188,6 +6253,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -6472,6 +6542,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -6762,6 +6837,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -6892,6 +6972,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -7343,6 +7428,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -7498,6 +7588,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -7870,6 +7965,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -8536,6 +8636,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -8889,6 +8994,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -9017,6 +9127,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -9445,6 +9560,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateFetchAccessToken": { +"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", +"parameterOrder": [ +"featureView" +], +"parameters": { +"featureView": { +"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+featureView}:generateFetchAccessToken", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single FeatureView.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", @@ -9884,6 +10027,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -10012,6 +10160,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -11157,6 +11310,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -11310,6 +11468,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -11463,6 +11626,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -11773,6 +11941,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -12229,6 +12402,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -12629,6 +12807,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -13152,6 +13335,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -13624,6 +13812,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -14035,6 +14228,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -14291,6 +14489,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -14504,6 +14707,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -14904,6 +15112,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -15420,6 +15633,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -16155,6 +16373,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -16412,6 +16635,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -17009,6 +17237,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -17425,6 +17658,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -17852,6 +18090,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -18005,6 +18248,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -18341,6 +18589,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -18717,6 +18970,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -19438,6 +19696,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -19712,6 +19975,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -19869,6 +20137,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -20925,6 +21198,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -21078,6 +21356,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -21380,6 +21663,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -21768,6 +22056,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -22141,6 +22434,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -22271,6 +22569,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -22556,6 +22859,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -22855,6 +23163,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -23292,6 +23605,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -23925,6 +24243,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -24305,6 +24628,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -24724,6 +25052,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -24881,6 +25214,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -25191,6 +25529,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -26923,7 +27266,7 @@ } } }, -"revision": "20250926", +"revision": "20251003", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -29320,7 +29663,8 @@ "IMAGE_PROHIBITED_CONTENT", "IMAGE_RECITATION", "IMAGE_OTHER", -"UNEXPECTED_TOOL_CALL" +"UNEXPECTED_TOOL_CALL", +"NO_IMAGE" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -29338,7 +29682,8 @@ "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", -"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." +"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", +"The model was expected to generate an image, but none was generated." ], "readOnly": true, "type": "string" @@ -31420,6 +31765,11 @@ "$ref": "GoogleCloudAiplatformV1beta1FlexStart", "description": "Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)" }, +"initialReplicaCount": { +"description": "Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.", +"format": "int32", +"type": "integer" +}, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "description": "Required. Immutable. The specification of a single machine being used." @@ -31439,6 +31789,10 @@ "format": "int32", "type": "integer" }, +"scaleToZeroSpec": { +"$ref": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec", +"description": "Optional. Specification for scale-to-zero feature." +}, "spot": { "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).", "type": "boolean" @@ -31446,6 +31800,23 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec": { +"description": "Specification for scale-to-zero feature.", +"id": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec", +"properties": { +"idleScaledownPeriod": { +"description": "Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)", +"format": "google-duration", +"type": "string" +}, +"minScaleupPeriod": { +"description": "Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesOperationMetadata": { "description": "Details of operations that delete Feature values.", "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesOperationMetadata", @@ -31805,6 +32176,13 @@ "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" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels with user-defined metadata to organize your Endpoints. 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.", +"type": "object" +}, "privateServiceConnectConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." @@ -31881,7 +32259,7 @@ "type": "string" }, "deploymentTier": { -"description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.", +"description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.", "enum": [ "DEPLOYMENT_TIER_UNSPECIFIED", "STORAGE" @@ -32597,6 +32975,28 @@ "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", "id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", "items": { @@ -33695,7 +34095,7 @@ "description": "Optional. Generation config." }, "model": { -"description": "Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, @@ -35978,6 +36378,15 @@ "autoScaling": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling", "description": "Required. Autoscaling config applied to Bigtable Instance." +}, +"bigtableMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata", +"description": "Output only. Metadata of the Bigtable instance. Output only.", +"readOnly": true +}, +"enableDirectBigtableAccess": { +"description": "Optional. It true, enable direct access to the Bigtable instance.", +"type": "boolean" } }, "type": "object" @@ -36003,6 +36412,25 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata": { +"description": "Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project.", +"id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata", +"properties": { +"instanceId": { +"description": "The Cloud Bigtable instance id.", +"type": "string" +}, +"tableId": { +"description": "The Cloud Bigtable table id.", +"type": "string" +}, +"tenantProjectId": { +"description": "Tenant project ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint": { "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", @@ -36273,6 +36701,11 @@ "$ref": "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource", "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore." }, +"bigtableMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata", +"description": "Output only. Metadata containing information about the Cloud Bigtable.", +"readOnly": true +}, "createTime": { "description": "Output only. Timestamp when this FeatureView was created.", "format": "google-datetime", @@ -36374,6 +36807,18 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata": { +"description": "Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances.", +"id": "GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata", +"properties": { +"readAppProfile": { +"description": "Output only. The Bigtable App Profile to use for reading from Bigtable.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FeatureViewDataKey": { "description": "Lookup key for a feature view.", "id": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", @@ -37500,6 +37945,25 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FullFineTuningSpec": { +"description": "Tuning Spec for Full Fine Tuning.", +"id": "GoogleCloudAiplatformV1beta1FullFineTuningSpec", +"properties": { +"hyperParameters": { +"$ref": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", +"description": "Optional. Hyperparameters for Full Fine Tuning." +}, +"trainingDatasetUri": { +"description": "Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", +"type": "string" +}, +"validationDatasetUri": { +"description": "Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FunctionCall": { "description": "A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.", "id": "GoogleCloudAiplatformV1beta1FunctionCall", @@ -37935,7 +38399,8 @@ "BLOCKLIST", "PROHIBITED_CONTENT", "MODEL_ARMOR", -"IMAGE_SAFETY" +"IMAGE_SAFETY", +"JAILBREAK" ], "enumDescriptions": [ "The blocked reason is unspecified.", @@ -37944,7 +38409,8 @@ "The prompt was blocked because it contains a term from the terminology blocklist.", "The prompt was blocked because it contains prohibited content.", "The prompt was blocked by Model Armor.", -"The prompt was blocked because it contains content that is unsafe for image generation." +"The prompt was blocked because it contains content that is unsafe for image generation.", +"The prompt was blocked as a jailbreak attempt." ], "readOnly": true, "type": "string" @@ -38052,6 +38518,28 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest": { +"description": "Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.", +"id": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse": { +"description": "Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.", +"id": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse", +"properties": { +"accessToken": { +"description": "The OAuth 2.0 access token.", +"type": "string" +}, +"expireTime": { +"description": "Token expiration time. This is always set", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest": { "description": "Request message for EvaluationService.GenerateInstanceRubrics.", "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest", @@ -38309,6 +38797,10 @@ "format": "float", "type": "number" }, +"imageConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ImageConfig", +"description": "Optional. Config for image generation features." +}, "logprobs": { "description": "Optional. Logit probabilities.", "format": "int32", @@ -39044,6 +39536,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ImageConfig": { +"description": "Config for image generation features.", +"id": "GoogleCloudAiplatformV1beta1ImageConfig", +"properties": { +"aspectRatio": { +"description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ImportDataConfig": { "description": "Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.", "id": "GoogleCloudAiplatformV1beta1ImportDataConfig", @@ -44392,6 +44895,20 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { +"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", +"id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", +"properties": { +"speakerVoiceConfigs": { +"description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", "id": "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata", @@ -51258,7 +51775,8 @@ false "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", -"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -51270,6 +51788,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -51282,7 +51801,8 @@ false "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", -"The harm category is image sexually explicit content." +"The harm category is image sexually explicit content.", +"The harm category is for jailbreak prompts." ], "readOnly": true, "type": "string" @@ -51401,7 +51921,8 @@ false "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", -"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_JAILBREAK" ], "enumDeprecated": [ false, @@ -51413,6 +51934,7 @@ true, false, false, false, +false, false ], "enumDescriptions": [ @@ -51425,7 +51947,8 @@ false "The harm category is image hate.", "The harm category is image dangerous content.", "The harm category is image harassment.", -"The harm category is image sexually explicit content." +"The harm category is image sexually explicit content.", +"The harm category is for jailbreak prompts." ], "type": "string" }, @@ -51546,6 +52069,11 @@ false "description": "SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironment", "properties": { +"connectionInfo": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo", +"description": "Output only. The connection information of the SandboxEnvironment.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this SandboxEnvironment was created.", "format": "google-datetime", @@ -51604,6 +52132,28 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo": { +"description": "The connection information of the SandboxEnvironment.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo", +"properties": { +"loadBalancerHostname": { +"description": "Output only. The hostname of the load balancer.", +"readOnly": true, +"type": "string" +}, +"loadBalancerIp": { +"description": "Output only. The IP address of the load balancer.", +"readOnly": true, +"type": "string" +}, +"sandboxInternalIp": { +"description": "Output only. The internal IP address of the SandboxEnvironment.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec": { "description": "The specification of a SandboxEnvironment.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec", @@ -51611,6 +52161,10 @@ false "codeExecutionEnvironment": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment", "description": "Optional. The code execution environment." +}, +"computerUseEnvironment": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment", +"description": "Optional. The computer use environment." } }, "type": "object" @@ -51648,6 +52202,12 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment": { +"description": "The computer use environment with customized settings.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SavedQuery": { "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", "id": "GoogleCloudAiplatformV1beta1SavedQuery", @@ -56873,6 +57433,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": { +"description": "Configuration for a single speaker in a multi speaker setup.", +"id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig", +"properties": { +"speaker": { +"description": "Required. The name of the speaker. This should be the same as the speaker name used in the prompt.", +"type": "string" +}, +"voiceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", +"description": "Required. The configuration for the voice of this speaker." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SpecialistPool": { "description": "SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers. Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.", "id": "GoogleCloudAiplatformV1beta1SpecialistPool", @@ -56967,6 +57542,10 @@ false "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", "type": "string" }, +"multiSpeakerVoiceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", +"description": "The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`." +}, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", "description": "The configuration for the speaker to use." @@ -59227,6 +59806,28 @@ false "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [\"amazon.com\", \"facebook.com\"].", "items": { @@ -60188,7 +60789,7 @@ false "type": "string" }, "model": { -"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`", +"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`", "readOnly": true, "type": "string" } @@ -60314,6 +60915,10 @@ false "readOnly": true, "type": "string" }, +"fullFineTuningSpec": { +"$ref": "GoogleCloudAiplatformV1beta1FullFineTuningSpec", +"description": "Tuning Spec for Full Fine Tuning." +}, "labels": { "additionalProperties": { "type": "string" @@ -60411,7 +61016,7 @@ false "readOnly": true }, "tunedModelDisplayName": { -"description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.", "type": "string" }, "tuningDataStats": { @@ -61534,6 +62139,13 @@ false "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 31b775b776..11e3a58fd8 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1627,7 +1627,7 @@ } } }, -"revision": "20251001", +"revision": "20251009", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4656,7 +4656,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -4761,6 +4762,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4866,7 +4868,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" }, @@ -5305,7 +5308,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -5410,6 +5414,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5515,7 +5520,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" } @@ -5865,11 +5871,11 @@ false "phase": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ -"WINDOW_PHASE_UNSPECIFIED", -"WINDOW_PHASE_ANY", -"WINDOW_PHASE_WEEK1", -"WINDOW_PHASE_WEEK2", -"WINDOW_PHASE_WEEK5" +"PHASE_UNSPECIFIED", +"ANY", +"WEEK1", +"WEEK2", +"WEEK5" ], "enumDescriptions": [ "Phase is unspecified.", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index db59307caf..5f8cd92219 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1627,7 +1627,7 @@ } } }, -"revision": "20251001", +"revision": "20251009", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2212,6 +2212,20 @@ false "$ref": "MaintenanceUpdatePolicy", "description": "Optional. The maintenance update policy determines when to allow or deny updates." }, +"maintenanceVersionSelectionPolicy": { +"description": "Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.", +"enum": [ +"MAINTENANCE_VERSION_SELECTION_POLICY_UNSPECIFIED", +"MAINTENANCE_VERSION_SELECTION_POLICY_LATEST", +"MAINTENANCE_VERSION_SELECTION_POLICY_DEFAULT" +], +"enumDescriptions": [ +"The maintenance version selection policy is not specified.", +"Use the latest available maintenance version.", +"Use the current default maintenance version." +], +"type": "string" +}, "migrationSource": { "$ref": "MigrationSource", "description": "Output only. Cluster created via DMS migration.", @@ -4902,7 +4916,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -5007,6 +5022,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5112,7 +5128,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" }, @@ -5551,7 +5568,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -5656,6 +5674,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5761,7 +5780,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" } @@ -6111,11 +6131,11 @@ false "phase": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ -"WINDOW_PHASE_UNSPECIFIED", -"WINDOW_PHASE_ANY", -"WINDOW_PHASE_WEEK1", -"WINDOW_PHASE_WEEK2", -"WINDOW_PHASE_WEEK5" +"PHASE_UNSPECIFIED", +"ANY", +"WEEK1", +"WEEK2", +"WEEK5" ], "enumDescriptions": [ "Phase is unspecified.", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index f8bc5a384c..0f0ef39a62 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1624,7 +1624,7 @@ } } }, -"revision": "20251001", +"revision": "20251009", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2198,6 +2198,20 @@ false "$ref": "MaintenanceUpdatePolicy", "description": "Optional. The maintenance update policy determines when to allow or deny updates." }, +"maintenanceVersionSelectionPolicy": { +"description": "Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.", +"enum": [ +"MAINTENANCE_VERSION_SELECTION_POLICY_UNSPECIFIED", +"MAINTENANCE_VERSION_SELECTION_POLICY_LATEST", +"MAINTENANCE_VERSION_SELECTION_POLICY_DEFAULT" +], +"enumDescriptions": [ +"The maintenance version selection policy is not specified.", +"Use the latest available maintenance version.", +"Use the current default maintenance version." +], +"type": "string" +}, "migrationSource": { "$ref": "MigrationSource", "description": "Output only. Cluster created via DMS migration.", @@ -4878,7 +4892,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -4983,6 +4998,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5088,7 +5104,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" }, @@ -5527,7 +5544,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -5632,6 +5650,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5737,7 +5756,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" } @@ -6087,11 +6107,11 @@ false "phase": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ -"WINDOW_PHASE_UNSPECIFIED", -"WINDOW_PHASE_ANY", -"WINDOW_PHASE_WEEK1", -"WINDOW_PHASE_WEEK2", -"WINDOW_PHASE_WEEK5" +"PHASE_UNSPECIFIED", +"ANY", +"WEEK1", +"WEEK2", +"WEEK5" ], "enumDescriptions": [ "Phase is unspecified.", diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index c229d0dc72..94d0d29748 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20250924", +"revision": "20251015", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1373,7 +1373,7 @@ "type": "string" }, "mtePolicy": { -"description": "Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.", +"description": "Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.", "enum": [ "MTE_POLICY_UNSPECIFIED", "MTE_USER_CHOICE", @@ -3055,6 +3055,178 @@ false }, "type": "object" }, +"DefaultApplication": { +"description": "Information about the application to be set as the default.", +"id": "DefaultApplication", +"properties": { +"packageName": { +"description": "Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.", +"type": "string" +} +}, +"type": "object" +}, +"DefaultApplicationContext": { +"description": "Additional context for non-compliance related to default application settings.", +"id": "DefaultApplicationContext", +"properties": { +"defaultApplicationScope": { +"description": "Output only. The scope of non-compliant default application setting.", +"enum": [ +"DEFAULT_APPLICATION_SCOPE_UNSPECIFIED", +"SCOPE_FULLY_MANAGED", +"SCOPE_WORK_PROFILE", +"SCOPE_PERSONAL_PROFILE" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"Sets the application as the default on fully managed devices.", +"Sets the application as the work profile default.Only supported for DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING, DEFAULT_DIALER and DEFAULT_WALLET.", +"Sets the application as the personal profile default on company-owned devices with a work profile. Only pre-installed system apps can be set as the default.Only supported for DEFAULT_BROWSER, DEFAULT_DIALER, DEFAULT_SMS and DEFAULT_WALLET." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DefaultApplicationInfo": { +"description": "The default application information for a specific DefaultApplicationType.", +"id": "DefaultApplicationInfo", +"properties": { +"defaultApplicationSettingAttempts": { +"description": "Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications.", +"items": { +"$ref": "DefaultApplicationSettingAttempt" +}, +"readOnly": true, +"type": "array" +}, +"defaultApplicationType": { +"description": "Output only. The default application type.", +"enum": [ +"DEFAULT_APPLICATION_TYPE_UNSPECIFIED", +"DEFAULT_ASSISTANT", +"DEFAULT_BROWSER", +"DEFAULT_CALL_REDIRECTION", +"DEFAULT_CALL_SCREENING", +"DEFAULT_DIALER", +"DEFAULT_HOME", +"DEFAULT_SMS", +"DEFAULT_WALLET" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"The assistant app type. This app type is only allowed to be set for SCOPE_FULLY_MANAGED.Supported on fully managed devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The browser app type.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The call redirection app type. This app type cannot be set for SCOPE_PERSONAL_PROFILE.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The call screening app type. This app type cannot be set for SCOPE_PERSONAL_PROFILE.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The dialer app type.Supported on fully managed devices on Android 14 and 15. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14.Supported on all management modes on Android 16 and above.", +"The home app type. This app type is only allowed to be set for SCOPE_FULLY_MANAGED.Supported on fully managed devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The SMS app type. This app type cannot be set for SCOPE_WORK_PROFILE.Supported on company-owned devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for personally-owned devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The wallet app type. The default application of this type applies across profiles.On a company-owned device with a work profile, admins can set the scope to SCOPE_PERSONAL_PROFILE to set a personal profile pre-installed system app as the default, or to SCOPE_WORK_PROFILE to set a work profile app as the default. It is not allowed to specify both scopes at the same time.Due to a known issue, the user may be able to change the default wallet even when this is set on a fully managed device.Supported on company-owned devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for personally-owned devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16." +], +"readOnly": true, +"type": "string" +}, +"packageName": { +"description": "Output only. The package name of the current default application.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DefaultApplicationSetting": { +"description": "The default application setting for a DefaultApplicationType.", +"id": "DefaultApplicationSetting", +"properties": { +"defaultApplicationScopes": { +"description": "Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).", +"items": { +"enum": [ +"DEFAULT_APPLICATION_SCOPE_UNSPECIFIED", +"SCOPE_FULLY_MANAGED", +"SCOPE_WORK_PROFILE", +"SCOPE_PERSONAL_PROFILE" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"Sets the application as the default on fully managed devices.", +"Sets the application as the work profile default.Only supported for DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING, DEFAULT_DIALER and DEFAULT_WALLET.", +"Sets the application as the personal profile default on company-owned devices with a work profile. Only pre-installed system apps can be set as the default.Only supported for DEFAULT_BROWSER, DEFAULT_DIALER, DEFAULT_SMS and DEFAULT_WALLET." +], +"type": "string" +}, +"type": "array" +}, +"defaultApplicationType": { +"description": "Required. The app type to set the default application.", +"enum": [ +"DEFAULT_APPLICATION_TYPE_UNSPECIFIED", +"DEFAULT_ASSISTANT", +"DEFAULT_BROWSER", +"DEFAULT_CALL_REDIRECTION", +"DEFAULT_CALL_SCREENING", +"DEFAULT_DIALER", +"DEFAULT_HOME", +"DEFAULT_SMS", +"DEFAULT_WALLET" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"The assistant app type. This app type is only allowed to be set for SCOPE_FULLY_MANAGED.Supported on fully managed devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The browser app type.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The call redirection app type. This app type cannot be set for SCOPE_PERSONAL_PROFILE.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The call screening app type. This app type cannot be set for SCOPE_PERSONAL_PROFILE.Supported on Android 16 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The dialer app type.Supported on fully managed devices on Android 14 and 15. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14.Supported on all management modes on Android 16 and above.", +"The home app type. This app type is only allowed to be set for SCOPE_FULLY_MANAGED.Supported on fully managed devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The SMS app type. This app type cannot be set for SCOPE_WORK_PROFILE.Supported on company-owned devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for personally-owned devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16.", +"The wallet app type. The default application of this type applies across profiles.On a company-owned device with a work profile, admins can set the scope to SCOPE_PERSONAL_PROFILE to set a personal profile pre-installed system app as the default, or to SCOPE_WORK_PROFILE to set a work profile app as the default. It is not allowed to specify both scopes at the same time.Due to a known issue, the user may be able to change the default wallet even when this is set on a fully managed device.Supported on company-owned devices on Android 16 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported for personally-owned devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 16." +], +"type": "string" +}, +"defaultApplications": { +"description": "Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.", +"items": { +"$ref": "DefaultApplication" +}, +"type": "array" +} +}, +"type": "object" +}, +"DefaultApplicationSettingAttempt": { +"description": "Details on a default application setting attempt.", +"id": "DefaultApplicationSettingAttempt", +"properties": { +"attemptOutcome": { +"description": "Output only. The outcome of setting the app as the default.", +"enum": [ +"ATTEMPT_OUTCOME_UNSPECIFIED", +"SUCCESS", +"APP_NOT_INSTALLED", +"APP_SIGNING_CERT_MISMATCH", +"OTHER_FAILURE" +], +"enumDescriptions": [ +"Attempt outcome is unspecified. This is not used.", +"App is successfully set as the default.", +"Attempt failed as the app is not installed.", +"Attempt failed as the signing key certificate fingerprint of the app from Play Store or from ApplicationPolicy.signingKeyCerts does not match the one on the device.", +"Attempt failed due to other reasons." +], +"readOnly": true, +"type": "string" +}, +"packageName": { +"description": "Output only. The package name of the attempted application.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Device": { "description": "A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.", "id": "Device", @@ -3115,6 +3287,14 @@ false "$ref": "CommonCriteriaModeInfo", "description": "Information about Common Criteria Mode\u2014security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned." }, +"defaultApplicationInfo": { +"description": "Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information.", +"items": { +"$ref": "DefaultApplicationInfo" +}, +"readOnly": true, +"type": "array" +}, "deviceSettings": { "$ref": "DeviceSettings", "description": "Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy." @@ -5263,7 +5443,9 @@ false "ONC_WIFI_KEY_PAIR_ALIAS_NOT_CORRESPONDING_TO_EXISTING_KEY", "PERMISSIBLE_USAGE_RESTRICTION", "REQUIRED_ACCOUNT_NOT_IN_ENTERPRISE", -"NEW_ACCOUNT_NOT_IN_ENTERPRISE" +"NEW_ACCOUNT_NOT_IN_ENTERPRISE", +"DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES", +"DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE" ], "enumDescriptions": [ "Specific non-compliance reason is not specified. Fields in specific_non_compliance_context are not set.", @@ -5277,7 +5459,9 @@ false "Key pair alias specified via ClientCertKeyPairAlias (https://chromium.googlesource.com/chromium/src/+/main/components/onc/docs/onc_spec.md#eap-type) field in openNetworkConfiguration does not correspond to an existing key installed on the device. nonComplianceReason is set to INVALID_VALUE.", "This policy setting is restricted and cannot be set for this Google Cloud Platform project. More details (including how to enable usage of this policy setting) are available in the Permissible Usage policy (https://developers.google.com/android/management/permissible-usage). nonComplianceReason is set to PROJECT_NOT_PERMITTED.", "Work account required by the workAccountSetupConfig policy setting is not part of the enterprise anymore. nonComplianceReason is set to USER_ACTION.", -"Work account added by the user is not part of the enterprise. nonComplianceReason is set to USER_ACTION." +"Work account added by the user is not part of the enterprise. nonComplianceReason is set to USER_ACTION.", +"The default application setting is applied to the scopes that are not supported by the management mode, even if the management mode itself is supported for the app type (e.g., a policy with DEFAULT_BROWSER app type and SCOPE_PERSONAL_PROFILE list sent to a fully managed device results in the scopes being inapplicable for the management mode). If the management mode is not supported for the app type, a NonComplianceDetail with MANAGEMENT_MODE is reported, without a specificNonComplianceReason.nonComplianceReason is set to MANAGEMENT_MODE.", +"The default application setting failed to apply for a specific scope. defaultApplicationContext is set. nonComplianceReason is set to INVALID_VALUE or APP_NOT_INSTALLED." ], "type": "string" } @@ -6004,6 +6188,13 @@ false "description": "Whether the user is allowed to enable debugging features.", "type": "boolean" }, +"defaultApplicationSettings": { +"description": "Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.", +"items": { +"$ref": "DefaultApplicationSetting" +}, +"type": "array" +}, "defaultPermissionPolicy": { "description": "The default permission policy for runtime permission requests.", "enum": [ @@ -7132,6 +7323,11 @@ false "description": "Additional context for SpecificNonComplianceReason.", "id": "SpecificNonComplianceContext", "properties": { +"defaultApplicationContext": { +"$ref": "DefaultApplicationContext", +"description": "Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE.", +"readOnly": true +}, "oncWifiContext": { "$ref": "OncWifiContext", "description": "Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL" @@ -7238,6 +7434,10 @@ false "description": "Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.", "type": "boolean" }, +"defaultApplicationInfoReportingEnabled": { +"description": "Optional. Whether defaultApplicationInfo reporting is enabled.", +"type": "boolean" +}, "deviceSettingsEnabled": { "description": "Whether device settings reporting is enabled.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json index f92140fc4f..9643c6debf 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1728,7 +1728,7 @@ } } }, -"revision": "20250519", +"revision": "20251008", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json new file mode 100644 index 0000000000..7c20c47a00 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json @@ -0,0 +1,802 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/bigquery": { +"description": "View and manage your data in Google BigQuery and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://bigquerydatapolicy.googleapis.com/", +"batchPath": "batch", +"canonicalName": "BigQuery DataPolicy Service", +"description": "Allows users to manage BigQuery data policies.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "bigquerydatapolicy:v2", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://bigquerydatapolicy.mtls.googleapis.com/", +"name": "bigquerydatapolicy", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"resources": { +"dataPolicies": { +"methods": { +"addGrantees": { +"description": "Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:addGrantees", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.addGrantees", +"parameterOrder": [ +"dataPolicy" +], +"parameters": { +"dataPolicy": { +"description": "Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+dataPolicy}:addGrantees", +"request": { +"$ref": "AddGranteesRequest" +}, +"response": { +"$ref": "DataPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Resource name of the project that the data policy will belong to. The format is `projects/{project_number}/locations/{location_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/dataPolicies", +"request": { +"$ref": "CreateDataPolicyRequest" +}, +"response": { +"$ref": "DataPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the data policy specified by its resource name.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}", +"httpMethod": "DELETE", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the data policy specified by its resource name.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}", +"httpMethod": "GET", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the requested data policy. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "DataPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the IAM policy for the specified data policy.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:getIamPolicy", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List all of the data policies in the specified parent project.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies", +"httpMethod": "GET", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filters the data policies by policy tags that they are associated with. Currently filter only supports \"policy_tag\" based filtering and OR based predicates. Sample filter can be \"policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3\". You may also use wildcard such as \"policy_tag: projects/1/locations/us/taxonomies/2*\". Please note that OR predicates cannot be used with wildcard filters.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `nextPageToken` value returned from a previous list request, if any. If not set, defaults to an empty string.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Resource name of the project for which to list data policies. Format is `projects/{project_number}/locations/{location_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/dataPolicies", +"response": { +"$ref": "ListDataPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}", +"httpMethod": "PATCH", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the `name` and `dataPolicyId` fields are not allowed.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "DataPolicy" +}, +"response": { +"$ref": "DataPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeGrantees": { +"description": "Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:removeGrantees", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.removeGrantees", +"parameterOrder": [ +"dataPolicy" +], +"parameters": { +"dataPolicy": { +"description": "Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+dataPolicy}:removeGrantees", +"request": { +"$ref": "RemoveGranteesRequest" +}, +"response": { +"$ref": "DataPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the IAM policy for the specified data policy.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:setIamPolicy", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns the caller's permission on the specified data policy resource.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:testIamPermissions", +"httpMethod": "POST", +"id": "bigquerydatapolicy.projects.locations.dataPolicies.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20251001", +"rootUrl": "https://bigquerydatapolicy.googleapis.com/", +"schemas": { +"AddGranteesRequest": { +"description": "Request message for the AddGrantees method.", +"id": "AddGranteesRequest", +"properties": { +"grantees": { +"description": "Required. IAM principal that should be granted Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuditConfig": { +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", +"id": "AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"CreateDataPolicyRequest": { +"description": "Request message for the CreateDataPolicy method.", +"id": "CreateDataPolicyRequest", +"properties": { +"dataPolicy": { +"$ref": "DataPolicy", +"description": "Required. The data policy to create. The `name` field does not need to be provided for the data policy creation." +}, +"dataPolicyId": { +"description": "Required. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.", +"type": "string" +} +}, +"type": "object" +}, +"DataMaskingPolicy": { +"description": "The policy used to specify data masking rule.", +"id": "DataMaskingPolicy", +"properties": { +"predefinedExpression": { +"description": "Optional. A predefined masking expression.", +"enum": [ +"PREDEFINED_EXPRESSION_UNSPECIFIED", +"SHA256", +"ALWAYS_NULL", +"DEFAULT_MASKING_VALUE", +"LAST_FOUR_CHARACTERS", +"FIRST_FOUR_CHARACTERS", +"EMAIL_MASK", +"DATE_YEAR_MASK", +"RANDOM_HASH" +], +"enumDescriptions": [ +"Default, unspecified predefined expression. No masking will take place since no expression is specified.", +"Masking expression to replace data with SHA-256 hash.", +"Masking expression to replace data with NULLs.", +"Masking expression to replace data with their default masking values. The default masking values for each type listed as below: * STRING: \"\" * BYTES: b'' * INTEGER: 0 * FLOAT: 0.0 * NUMERIC: 0 * BOOLEAN: FALSE * TIMESTAMP: 1970-01-01 00:00:00 UTC * DATE: 1970-01-01 * TIME: 00:00:00 * DATETIME: 1970-01-01T00:00:00 * GEOGRAPHY: POINT(0 0) * BIGNUMERIC: 0 * ARRAY: [] * STRUCT: NOT_APPLICABLE * JSON: NULL", +"Masking expression shows the last four characters of text. The masking behavior is as follows: * If text length > 4 characters: Replace text with XXXXX, append last four characters of original text. * If text length <= 4 characters: Apply SHA-256 hash.", +"Masking expression shows the first four characters of text. The masking behavior is as follows: * If text length > 4 characters: Replace text with XXXXX, prepend first four characters of original text. * If text length <= 4 characters: Apply SHA-256 hash.", +"Masking expression for email addresses. The masking behavior is as follows: * Syntax-valid email address: Replace username with XXXXX. For example, cloudysanfrancisco@gmail.com becomes XXXXX@gmail.com. * Syntax-invalid email address: Apply SHA-256 hash. For more information, see [Email mask](https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options).", +"Masking expression to only show the *year* of `Date`, `DateTime` and `TimeStamp`. For example, with the year 2076: * DATE : 2076-01-01 * DATETIME : 2076-01-01T00:00:00 * TIMESTAMP : 2076-01-01 00:00:00 UTC Truncation occurs according to the UTC time zone. To change this, adjust the default time zone using the `time_zone` system variable. For more information, see [System variables reference](https://cloud.google.com/bigquery/docs/reference/system-variables).", +"Masking expression that uses hashing to mask column data. It differs from SHA256 in that a unique random value is generated for each query and is added to the hash input, resulting in the hash / masked result to be different for each query. Hence the name \"random hash\"." +], +"type": "string" +}, +"routine": { +"description": "Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"DataPolicy": { +"description": "Represents the label-policy binding.", +"id": "DataPolicy", +"properties": { +"dataMaskingPolicy": { +"$ref": "DataMaskingPolicy", +"description": "Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY." +}, +"dataPolicyId": { +"description": "Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.", +"readOnly": true, +"type": "string" +}, +"dataPolicyType": { +"description": "Required. Type of data policy.", +"enum": [ +"DATA_POLICY_TYPE_UNSPECIFIED", +"DATA_MASKING_POLICY", +"RAW_DATA_ACCESS_POLICY", +"COLUMN_LEVEL_SECURITY_POLICY" +], +"enumDescriptions": [ +"Default value for the data policy type. This should not be used.", +"Used to create a data policy for data masking.", +"Used to create a data policy for raw data access.", +"Used to create a data policy for column-level security, without data masking. This is deprecated in V2 api and only present to support GET and LIST operations for V1 data policies in V2 api." +], +"type": "string" +}, +"etag": { +"description": "The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.", +"type": "string" +}, +"grantees": { +"description": "Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", +"type": "string" +}, +"policyTag": { +"description": "Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.", +"readOnly": true, +"type": "string" +}, +"version": { +"description": "Output only. The version of the Data Policy resource.", +"enum": [ +"VERSION_UNSPECIFIED", +"V1", +"V2" +], +"enumDescriptions": [ +"Default value for the data policy version. This should not be used.", +"V1 data policy version. V1 Data Policies will be present in V2 List api response, but can not be created/updated/deleted from V2 api.", +"V2 data policy version." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "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); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"GetIamPolicyRequest": { +"description": "Request message for `GetIamPolicy` method.", +"id": "GetIamPolicyRequest", +"properties": { +"options": { +"$ref": "GetPolicyOptions", +"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." +} +}, +"type": "object" +}, +"GetPolicyOptions": { +"description": "Encapsulates settings provided to GetIamPolicy.", +"id": "GetPolicyOptions", +"properties": { +"requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ListDataPoliciesResponse": { +"description": "Response message for the ListDataPolicies method.", +"id": "ListDataPoliciesResponse", +"properties": { +"dataPolicies": { +"description": "Data policies that belong to the requested project.", +"items": { +"$ref": "DataPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token used to retrieve the next page of results, or empty if there are no more results.", +"type": "string" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"RemoveGranteesRequest": { +"description": "Request message for the RemoveGrantees method.", +"id": "RemoveGranteesRequest", +"properties": { +"grantees": { +"description": "Required. IAM principal that should be revoked from Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "BigQuery Data Policy API", +"version": "v2", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 9a1bde43e1..37d6d3cc9f 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1267,7 +1267,7 @@ } } }, -"revision": "20250907", +"revision": "20251009", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1313,6 +1313,10 @@ "readOnly": true, "type": "string" }, +"schedulingPolicy": { +"$ref": "SchedulingPolicy", +"description": "Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available." +}, "state": { "description": "Output only. State of the assignment.", "enum": [ @@ -1916,6 +1920,10 @@ false ], "type": "string" }, +"schedulingPolicy": { +"$ref": "SchedulingPolicy", +"description": "Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available." +}, "secondaryLocation": { "description": "Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).", "type": "string" @@ -1945,6 +1953,23 @@ false }, "type": "object" }, +"SchedulingPolicy": { +"description": "The scheduling policy controls how a reservation's resources are distributed.", +"id": "SchedulingPolicy", +"properties": { +"concurrency": { +"description": "Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.", +"format": "int64", +"type": "string" +}, +"maxSlots": { +"description": "Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "SearchAllAssignmentsResponse": { "description": "The response for ReservationService.SearchAllAssignments.", "id": "SearchAllAssignmentsResponse", diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index c0a9bbb400..de0f15c1b2 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2856,6 +2856,38 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:getIamPolicy", +"httpMethod": "POST", +"id": "bigtableadmin.projects.instances.tables.schemaBundles.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/schemaBundles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists all schema bundles associated with the specified table.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles", @@ -2955,6 +2987,70 @@ "https://www.googleapis.com/auth/cloud-bigtable.admin.table", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on a Bigtable resource. Replaces any existing policy.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:setIamPolicy", +"httpMethod": "POST", +"id": "bigtableadmin.projects.instances.tables.schemaBundles.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/schemaBundles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that the caller has on the specified Bigtable resource.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:testIamPermissions", +"httpMethod": "POST", +"id": "bigtableadmin.projects.instances.tables.schemaBundles.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/schemaBundles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.table", +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -3022,7 +3118,7 @@ } } }, -"revision": "20251004", +"revision": "20251012", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index a69e79c8d6..5fdea6d48a 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1535,7 +1535,7 @@ } } }, -"revision": "20251002", +"revision": "20251014", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2077,7 +2077,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", -"A Google Chat app. Not used for Google Workspace add-ons." +"A Google Chat app." ], "type": "string" }, @@ -3041,7 +3041,7 @@ "type": "string" }, "valueMsEpoch": { -"description": "The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", +"description": "Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", "format": "int64", "type": "string" } @@ -4708,7 +4708,7 @@ "type": "string" }, "formattedText": { -"description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)", +"description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)\u2014for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 813f8547fc..cdc1d62390 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1657,7 +1657,7 @@ } } }, -"revision": "20251006", +"revision": "20251014", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -3694,16 +3694,40 @@ false "readOnly": true, "type": "string" }, +"gatewayIpv6Address": { +"description": "Output only. The gateway IPv6 for this interface, if detected", +"readOnly": true, +"type": "string" +}, "guid": { "description": "Output only. Network connection guid.", "readOnly": true, "type": "string" }, +"ipv6Address": { +"description": "Output only. IPv6 addresses assigned to this network, if any. Each address is a string in standard IPv6 text representation (e.g., \"2001:db8::1\").", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "lanIpAddress": { "description": "Output only. LAN IP address.", "readOnly": true, "type": "string" }, +"linkDownSpeedKbps": { +"description": "Output only. The maximum downstream bandwidth in Kilobits per second (Kbps), if reported by the network interface or connection.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"metered": { +"description": "Output only. Whether the network was detected as metered.", +"readOnly": true, +"type": "boolean" +}, "receivingBitRateMbps": { "description": "Output only. Receiving bit rate measured in Megabits per second.", "format": "int64", @@ -4824,6 +4848,11 @@ false ], "type": "string" }, +"externalDisplaysEvent": { +"$ref": "GoogleChromeManagementV1TelemetryExternalDisplayEvent", +"description": "Output only. Payload for external display connected/disconnected event. Present only when `event_type` is `EXTERNAL_DISPLAY_CONNECTED` or `EXTERNAL_DISPLAY_DISCONNECTED`.", +"readOnly": true +}, "httpsLatencyChangeEvent": { "$ref": "GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent", "description": "Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`.", @@ -4920,6 +4949,55 @@ false }, "type": "object" }, +"GoogleChromeManagementV1TelemetryExternalDisplayData": { +"description": "External display data.", +"id": "GoogleChromeManagementV1TelemetryExternalDisplayData", +"properties": { +"displayName": { +"description": "The display name.", +"type": "string" +}, +"edidVersion": { +"description": "The EDID version.", +"type": "string" +}, +"refreshRate": { +"description": "The refresh rate.", +"format": "int64", +"type": "string" +}, +"resolutionHorizontal": { +"description": "The horizontal resolution.", +"format": "int32", +"type": "integer" +}, +"resolutionVertical": { +"description": "The vertical resolution.", +"format": "int32", +"type": "integer" +}, +"serialNumber": { +"description": "The serial number.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1TelemetryExternalDisplayEvent": { +"description": "External display connected/disconnected event payload.", +"id": "GoogleChromeManagementV1TelemetryExternalDisplayEvent", +"properties": { +"externalDisplayData": { +"description": "List of external displays that were connected/disconnected.", +"items": { +"$ref": "GoogleChromeManagementV1TelemetryExternalDisplayData" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent": { "description": "Https latency routine is run periodically and `TelemetryHttpsLatencyChangeEvent` is triggered if a latency problem was detected or if the device has recovered from a latency problem. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT", "id": "GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent", diff --git a/googleapiclient/discovery_cache/documents/chromewebstore.v1.1.json b/googleapiclient/discovery_cache/documents/chromewebstore.v1.1.json index 8283e10bed..822241f5c1 100644 --- a/googleapiclient/discovery_cache/documents/chromewebstore.v1.1.json +++ b/googleapiclient/discovery_cache/documents/chromewebstore.v1.1.json @@ -17,7 +17,7 @@ "canonicalName": "Chromewebstore", "description": "The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.", "discoveryVersion": "v1", -"documentationLink": "https://developer.chrome.com/webstore/api_index", +"documentationLink": "https://developer.chrome.com/docs/webstore/api", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -268,7 +268,7 @@ } } }, -"revision": "20251006", +"revision": "20251015", "rootUrl": "https://chromewebstore.googleapis.com/", "schemas": { "Item": { diff --git a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json index ab2dcbd6d5..c945304186 100644 --- a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json @@ -161,7 +161,7 @@ "ACCOUNT_VIEW_FULL" ], "enumDescriptions": [ -"The default / unset value. For `GetAccount`, it defaults to the FULL view. For `ListAccounts`, it only supports BASIC view.", +"The default / unset value. For `GetAccount` and `ListAccounts`, they default to the BASIC view. For `ListAccounts`, it only supports the BASIC view.", "Include base account information. This is the default view. All fields from Account are included except for the reseller_parent_billing_account field.", "Includes all available account information, inclusive of the accounts reseller_parent_billing_account, if it's a resold account." ], @@ -518,7 +518,7 @@ } } }, -"revision": "20250923", +"revision": "20251012", "rootUrl": "https://cloudcommerceprocurement.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 5a0d26faf3..ad53752ebb 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -36994,6 +36994,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.reservationBlocks.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "list": { "description": "Retrieves a list of reservation blocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", @@ -37115,6 +37172,113 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.reservationBlocks.setIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", +"request": { +"$ref": "ZoneSetNestedPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.reservationBlocks.testIamPermissions", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] } } }, @@ -37167,6 +37331,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.reservationSubBlocks.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", @@ -37339,6 +37560,113 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.setIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"request": { +"$ref": "ZoneSetNestedPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.testIamPermissions", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] } } }, @@ -48096,7 +48424,7 @@ } } }, -"revision": "20250930", +"revision": "20251015", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -108542,6 +108870,28 @@ false }, "type": "object" }, +"ZoneSetNestedPolicyRequest": { +"id": "ZoneSetNestedPolicyRequest", +"properties": { +"bindings": { +"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify the etag.", +"format": "byte", +"type": "string" +}, +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them." +} +}, +"type": "object" +}, "ZoneSetPolicyRequest": { "id": "ZoneSetPolicyRequest", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 806ec0580b..f3b4edc504 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -31510,6 +31510,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.reservationBlocks.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "list": { "description": "Retrieves a list of reservation blocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", @@ -31631,6 +31688,113 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.reservationBlocks.setIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", +"request": { +"$ref": "ZoneSetNestedPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.reservationBlocks.testIamPermissions", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] } } }, @@ -31683,6 +31847,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.reservationSubBlocks.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", @@ -31855,6 +32076,113 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.setIamPolicy", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"request": { +"$ref": "ZoneSetNestedPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.testIamPermissions", +"parameterOrder": [ +"project", +"zone", +"parentResource", +"resource" +], +"parameters": { +"parentResource": { +"description": "Name or id of parent resource of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] } } }, @@ -42028,7 +42356,7 @@ } } }, -"revision": "20250930", +"revision": "20251015", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -96685,6 +97013,28 @@ false }, "type": "object" }, +"ZoneSetNestedPolicyRequest": { +"id": "ZoneSetNestedPolicyRequest", +"properties": { +"bindings": { +"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify the etag.", +"format": "byte", +"type": "string" +}, +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them." +} +}, +"type": "object" +}, "ZoneSetPolicyRequest": { "id": "ZoneSetPolicyRequest", "properties": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 090ae0d469..0d3726c45b 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -5648,7 +5648,7 @@ } } }, -"revision": "20251007", +"revision": "20251014", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -7565,7 +7565,8 @@ true "CONVERSATION_PROFILE_ID", "MEDIUM", "AGENT_VERSION_ID", -"AGENT_DEPLOYMENT_ID" +"AGENT_DEPLOYMENT_ID", +"AGENT_ASSIST_SUPERVISOR_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -7579,7 +7580,8 @@ true "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the agent version ID.", -"The dimension is keyed by the agent deployment ID." +"The dimension is keyed by the agent deployment ID.", +"The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents." ], "type": "string" }, @@ -12106,7 +12108,8 @@ true "CONVERSATION_PROFILE_ID", "MEDIUM", "AGENT_VERSION_ID", -"AGENT_DEPLOYMENT_ID" +"AGENT_DEPLOYMENT_ID", +"AGENT_ASSIST_SUPERVISOR_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -12120,7 +12123,8 @@ true "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the agent version ID.", -"The dimension is keyed by the agent deployment ID." +"The dimension is keyed by the agent deployment ID.", +"The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index feede55371..4e3da818a5 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2660,7 +2660,7 @@ } } }, -"revision": "20250923", +"revision": "20250930", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4406,6 +4406,10 @@ "privateRegistryAccessConfig": { "$ref": "PrivateRegistryAccessConfig", "description": "PrivateRegistryAccessConfig is used to configure access configuration for private container registries." +}, +"writableCgroups": { +"$ref": "WritableCgroups", +"description": "Optional. WritableCgroups defines writable cgroups configuration for the node pool." } }, "type": "object" @@ -6536,7 +6540,7 @@ false "type": "boolean" }, "cpuCfsQuotaPeriod": { -"description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration.", +"description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration between 1ms and 1 second, inclusive.", "type": "string" }, "cpuManagerPolicy": { @@ -9361,6 +9365,17 @@ false } }, "type": "object" +}, +"WritableCgroups": { +"description": "Defines writable cgroups configuration.", +"id": "WritableCgroups", +"properties": { +"enabled": { +"description": "Optional. Whether writable cgroups is enabled.", +"type": "boolean" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index ca9f7614c6..f013be7f6a 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250923", +"revision": "20250930", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3834,6 +3834,10 @@ "$ref": "SecretManagerConfig", "description": "Secret CSI driver configuration." }, +"secretSyncConfig": { +"$ref": "SecretSyncConfig", +"description": "Configuration for sync Secret Manager secrets as k8s secrets." +}, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -4603,6 +4607,10 @@ "privateRegistryAccessConfig": { "$ref": "PrivateRegistryAccessConfig", "description": "PrivateRegistryAccessConfig is used to configure access configuration for private container registries." +}, +"writableCgroups": { +"$ref": "WritableCgroups", +"description": "Optional. WritableCgroups defines writable cgroups configuration for the node pool." } }, "type": "object" @@ -6930,7 +6938,7 @@ false "type": "boolean" }, "cpuCfsQuotaPeriod": { -"description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration.", +"description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration between 1ms and 1 second, inclusive.", "type": "string" }, "cpuManagerPolicy": { @@ -8337,6 +8345,21 @@ false }, "type": "object" }, +"SecretSyncConfig": { +"description": "Configuration for sync Secret Manager secrets as k8s secrets.", +"id": "SecretSyncConfig", +"properties": { +"enabled": { +"description": "Enable/Disable Secret Sync Config.", +"type": "boolean" +}, +"rotationConfig": { +"$ref": "SyncRotationConfig", +"description": "Rotation config for secret manager." +} +}, +"type": "object" +}, "SecurityBulletinEvent": { "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", "id": "SecurityBulletinEvent", @@ -9114,6 +9137,22 @@ false }, "type": "object" }, +"SyncRotationConfig": { +"description": "SyncRotationConfig is config for secret manager auto rotation.", +"id": "SyncRotationConfig", +"properties": { +"enabled": { +"description": "Whether the rotation is enabled.", +"type": "boolean" +}, +"rotationInterval": { +"description": "The interval between two consecutive rotations. Default rotation interval is 2 minutes.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "TimeWindow": { "description": "Represents an arbitrary window of time.", "id": "TimeWindow", @@ -9981,6 +10020,17 @@ true } }, "type": "object" +}, +"WritableCgroups": { +"description": "Defines writable cgroups configuration.", +"id": "WritableCgroups", +"properties": { +"enabled": { +"description": "Optional. Whether writable cgroups is enabled.", +"type": "boolean" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json new file mode 100644 index 0000000000..a9105dba39 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -0,0 +1,4918 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/bigquery": { +"description": "View and manage your data in Google BigQuery and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://dataform.googleapis.com/", +"batchPath": "batch", +"description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/dataform/docs", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "dataform:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://dataform.mtls.googleapis.com/", +"name": "dataform", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getConfig": { +"description": "Get default config for a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config", +"httpMethod": "GET", +"id": "dataform.projects.locations.getConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The config name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/config$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Config" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v1/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "dataform.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"location": "query", +"repeated": true, +"type": "string" +}, +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateConfig": { +"description": "Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config", +"httpMethod": "PATCH", +"id": "dataform.projects.locations.updateConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The config name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/config$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Specifies the fields to be updated in the config.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Config" +}, +"response": { +"$ref": "Config" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"folders": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataform.projects.locations.folders.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataform.projects.locations.folders.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataform.projects.locations.folders.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "dataform.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "dataform.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"repositories": { +"methods": { +"commit": { +"description": "Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:commit", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.commit", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:commit", +"request": { +"$ref": "CommitRepositoryChangesRequest" +}, +"response": { +"$ref": "CommitRepositoryChangesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"computeAccessTokenStatus": { +"description": "Computes a Repository's Git access token status.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:computeAccessTokenStatus", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.computeAccessTokenStatus", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:computeAccessTokenStatus", +"response": { +"$ref": "ComputeRepositoryAccessTokenStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a new Repository in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"repositoryId": { +"description": "Required. The ID to use for the repository, which will become the final component of the repository's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/repositories", +"request": { +"$ref": "Repository" +}, +"response": { +"$ref": "Repository" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.repositories.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchHistory": { +"description": "Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchHistory", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.fetchHistory", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:fetchHistory", +"response": { +"$ref": "FetchRepositoryHistoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchRemoteBranches": { +"description": "Fetches a Repository's remote branches.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchRemoteBranches", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.fetchRemoteBranches", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:fetchRemoteBranches", +"response": { +"$ref": "FetchRemoteBranchesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Repository" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter for the returned list.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/repositories", +"response": { +"$ref": "ListRepositoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", +"httpMethod": "PATCH", +"id": "dataform.projects.locations.repositories.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Repository" +}, +"response": { +"$ref": "Repository" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryDirectoryContents": { +"description": "Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:queryDirectoryContents", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.queryDirectoryContents", +"parameterOrder": [ +"name" +], +"parameters": { +"commitSha": { +"description": "Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"path": { +"description": "Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:queryDirectoryContents", +"response": { +"$ref": "QueryRepositoryDirectoryContentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"readFile": { +"description": "Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:readFile", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.readFile", +"parameterOrder": [ +"name" +], +"parameters": { +"commitSha": { +"description": "Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"path": { +"description": "Required. Full file path to read including filename, from repository root.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:readFile", +"response": { +"$ref": "ReadRepositoryFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"compilationResults": { +"methods": { +"create": { +"description": "Creates a new CompilationResult in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.compilationResults.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/compilationResults", +"request": { +"$ref": "CompilationResult" +}, +"response": { +"$ref": "CompilationResult" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single CompilationResult.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.compilationResults.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The compilation result's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "CompilationResult" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists CompilationResults in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.compilationResults.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter for the returned list.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/compilationResults", +"response": { +"$ref": "ListCompilationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Returns CompilationResultActions in a given CompilationResult.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}:query", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.compilationResults.query", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The compilation result's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:query", +"response": { +"$ref": "QueryCompilationResultActionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"releaseConfigs": { +"methods": { +"create": { +"description": "Creates a new ReleaseConfig in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.releaseConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"releaseConfigId": { +"description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/releaseConfigs", +"request": { +"$ref": "ReleaseConfig" +}, +"response": { +"$ref": "ReleaseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single ReleaseConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.repositories.releaseConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The release config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single ReleaseConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.releaseConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The release config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ReleaseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ReleaseConfigs in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.releaseConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/releaseConfigs", +"response": { +"$ref": "ListReleaseConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", +"httpMethod": "PATCH", +"id": "dataform.projects.locations.repositories.releaseConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The release config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "ReleaseConfig" +}, +"response": { +"$ref": "ReleaseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"workflowConfigs": { +"methods": { +"create": { +"description": "Creates a new WorkflowConfig in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workflowConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"workflowConfigId": { +"description": "Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/workflowConfigs", +"request": { +"$ref": "WorkflowConfig" +}, +"response": { +"$ref": "WorkflowConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single WorkflowConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.repositories.workflowConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single WorkflowConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workflowConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WorkflowConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WorkflowConfigs in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workflowConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/workflowConfigs", +"response": { +"$ref": "ListWorkflowConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", +"httpMethod": "PATCH", +"id": "dataform.projects.locations.repositories.workflowConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The workflow config's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "WorkflowConfig" +}, +"response": { +"$ref": "WorkflowConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"workflowInvocations": { +"methods": { +"cancel": { +"description": "Requests cancellation of a running WorkflowInvocation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:cancel", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workflowInvocations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow invocation resource's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelWorkflowInvocationRequest" +}, +"response": { +"$ref": "CancelWorkflowInvocationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a new WorkflowInvocation in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workflowInvocations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/workflowInvocations", +"request": { +"$ref": "WorkflowInvocation" +}, +"response": { +"$ref": "WorkflowInvocation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single WorkflowInvocation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.repositories.workflowInvocations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow invocation resource's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single WorkflowInvocation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workflowInvocations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow invocation resource's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WorkflowInvocation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WorkflowInvocations in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workflowInvocations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter for the returned list.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/workflowInvocations", +"response": { +"$ref": "ListWorkflowInvocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Returns WorkflowInvocationActions in a given WorkflowInvocation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:query", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workflowInvocations.query", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workflow invocation's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:query", +"response": { +"$ref": "QueryWorkflowInvocationActionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"workspaces": { +"methods": { +"commit": { +"description": "Applies a Git commit for uncommitted files in a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:commit", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.commit", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:commit", +"request": { +"$ref": "CommitWorkspaceChangesRequest" +}, +"response": { +"$ref": "CommitWorkspaceChangesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a new Workspace in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"workspaceId": { +"description": "Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/workspaces", +"request": { +"$ref": "Workspace" +}, +"response": { +"$ref": "Workspace" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}", +"httpMethod": "DELETE", +"id": "dataform.projects.locations.repositories.workspaces.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace resource's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchFileDiff": { +"description": "Fetches Git diff for an uncommitted file in a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileDiff", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.fetchFileDiff", +"parameterOrder": [ +"workspace" +], +"parameters": { +"path": { +"description": "Required. The file's full path including filename, relative to the workspace root.", +"location": "query", +"type": "string" +}, +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:fetchFileDiff", +"response": { +"$ref": "FetchFileDiffResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchFileGitStatuses": { +"description": "Fetches Git statuses for the files in a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileGitStatuses", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:fetchFileGitStatuses", +"response": { +"$ref": "FetchFileGitStatusesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchGitAheadBehind": { +"description": "Fetches Git ahead/behind against a remote branch.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchGitAheadBehind", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +}, +"remoteBranch": { +"description": "Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:fetchGitAheadBehind", +"response": { +"$ref": "FetchGitAheadBehindResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Fetches a single Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Workspace" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"installNpmPackages": { +"description": "Installs dependency NPM packages (inside a Workspace).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.installNpmPackages", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:installNpmPackages", +"request": { +"$ref": "InstallNpmPackagesRequest" +}, +"response": { +"$ref": "InstallNpmPackagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Workspaces in a given Repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter for the returned list.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/workspaces", +"response": { +"$ref": "ListWorkspacesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"makeDirectory": { +"description": "Creates a directory inside a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:makeDirectory", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.makeDirectory", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:makeDirectory", +"request": { +"$ref": "MakeDirectoryRequest" +}, +"response": { +"$ref": "MakeDirectoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"moveDirectory": { +"description": "Moves a directory (inside a Workspace), and all of its contents, to a new location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveDirectory", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.moveDirectory", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:moveDirectory", +"request": { +"$ref": "MoveDirectoryRequest" +}, +"response": { +"$ref": "MoveDirectoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"moveFile": { +"description": "Moves a file (inside a Workspace) to a new location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.moveFile", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:moveFile", +"request": { +"$ref": "MoveFileRequest" +}, +"response": { +"$ref": "MoveFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pull": { +"description": "Pulls Git commits from the Repository's remote into a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:pull", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.pull", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:pull", +"request": { +"$ref": "PullGitCommitsRequest" +}, +"response": { +"$ref": "PullGitCommitsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"push": { +"description": "Pushes Git commits from a Workspace to the Repository's remote.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:push", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.push", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:push", +"request": { +"$ref": "PushGitCommitsRequest" +}, +"response": { +"$ref": "PushGitCommitsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryDirectoryContents": { +"description": "Returns the contents of a given Workspace directory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:queryDirectoryContents", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.queryDirectoryContents", +"parameterOrder": [ +"workspace" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"path": { +"description": "Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.", +"location": "query", +"type": "string" +}, +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:queryDirectoryContents", +"response": { +"$ref": "QueryDirectoryContentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"readFile": { +"description": "Returns the contents of a file (inside a Workspace).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:readFile", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.readFile", +"parameterOrder": [ +"workspace" +], +"parameters": { +"path": { +"description": "Required. The file's full path including filename, relative to the workspace root.", +"location": "query", +"type": "string" +}, +"revision": { +"description": "Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.", +"location": "query", +"type": "string" +}, +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:readFile", +"response": { +"$ref": "ReadFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeDirectory": { +"description": "Deletes a directory (inside a Workspace) and all of its contents.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeDirectory", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.removeDirectory", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:removeDirectory", +"request": { +"$ref": "RemoveDirectoryRequest" +}, +"response": { +"$ref": "RemoveDirectoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeFile": { +"description": "Deletes a file (inside a Workspace).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeFile", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.removeFile", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:removeFile", +"request": { +"$ref": "RemoveFileRequest" +}, +"response": { +"$ref": "RemoveFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reset": { +"description": "Performs a Git reset for uncommitted files in a Workspace.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:reset", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.reset", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reset", +"request": { +"$ref": "ResetWorkspaceChangesRequest" +}, +"response": { +"$ref": "ResetWorkspaceChangesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"searchFiles": { +"description": "Finds the contents of a given Workspace directory by filter.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:searchFiles", +"httpMethod": "GET", +"id": "dataform.projects.locations.repositories.workspaces.searchFiles", +"parameterOrder": [ +"workspace" +], +"parameters": { +"filter": { +"description": "Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:searchFiles", +"response": { +"$ref": "SearchFilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"writeFile": { +"description": "Writes to a file (inside a Workspace).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.writeFile", +"parameterOrder": [ +"workspace" +], +"parameters": { +"workspace": { +"description": "Required. The workspace's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+workspace}:writeFile", +"request": { +"$ref": "WriteFileRequest" +}, +"response": { +"$ref": "WriteFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"teamFolders": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataform.projects.locations.teamFolders.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataform.projects.locations.teamFolders.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataform.projects.locations.teamFolders.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20251007", +"rootUrl": "https://dataform.googleapis.com/", +"schemas": { +"ActionErrorTable": { +"description": "Error table information, used to write error data into a BigQuery table.", +"id": "ActionErrorTable", +"properties": { +"retentionDays": { +"description": "Error table partition expiration in days. Only positive values are allowed.", +"format": "int32", +"type": "integer" +}, +"target": { +"$ref": "Target", +"description": "Error Table target." +} +}, +"type": "object" +}, +"ActionIncrementalLoadMode": { +"description": "Load definition for incremental load modes", +"id": "ActionIncrementalLoadMode", +"properties": { +"column": { +"description": "Column name for incremental load modes", +"type": "string" +} +}, +"type": "object" +}, +"ActionLoadConfig": { +"description": "Simplified load configuration for actions", +"id": "ActionLoadConfig", +"properties": { +"append": { +"$ref": "ActionSimpleLoadMode", +"description": "Append into destination table" +}, +"maximum": { +"$ref": "ActionIncrementalLoadMode", +"description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" +}, +"replace": { +"$ref": "ActionSimpleLoadMode", +"description": "Replace destination table" +}, +"unique": { +"$ref": "ActionIncrementalLoadMode", +"description": "Insert records where the value of a column is not already present in the destination table" +} +}, +"type": "object" +}, +"ActionSimpleLoadMode": { +"description": "Simple load definition", +"id": "ActionSimpleLoadMode", +"properties": {}, +"type": "object" +}, +"ActionSqlDefinition": { +"description": "Definition of a SQL Data Preparation", +"id": "ActionSqlDefinition", +"properties": { +"errorTable": { +"$ref": "ActionErrorTable", +"description": "Error table configuration," +}, +"loadConfig": { +"$ref": "ActionLoadConfig", +"description": "Load configuration." +}, +"query": { +"description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", +"type": "string" +} +}, +"type": "object" +}, +"Assertion": { +"description": "Represents an assertion upon a SQL query which is required return zero rows.", +"id": "Assertion", +"properties": { +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"parentAction": { +"$ref": "Target", +"description": "The parent action of this assertion. Only set if this assertion was automatically generated." +}, +"relationDescriptor": { +"$ref": "RelationDescriptor", +"description": "Descriptor for the assertion's automatically-generated view and its columns." +}, +"selectQuery": { +"description": "The SELECT query which must return zero rows in order for this assertion to succeed.", +"type": "string" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BigQueryAction": { +"description": "Represents a workflow action that will run against BigQuery.", +"id": "BigQueryAction", +"properties": { +"jobId": { +"description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.", +"readOnly": true, +"type": "string" +}, +"sqlScript": { +"description": "Output only. The generated BigQuery SQL script that will be executed.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"CancelWorkflowInvocationRequest": { +"description": "`CancelWorkflowInvocation` request message.", +"id": "CancelWorkflowInvocationRequest", +"properties": {}, +"type": "object" +}, +"CancelWorkflowInvocationResponse": { +"description": "`CancelWorkflowInvocation` response message.", +"id": "CancelWorkflowInvocationResponse", +"properties": {}, +"type": "object" +}, +"CodeCompilationConfig": { +"description": "Configures various aspects of Dataform code compilation.", +"id": "CodeCompilationConfig", +"properties": { +"assertionSchema": { +"description": "Optional. The default schema (BigQuery dataset ID) for assertions.", +"type": "string" +}, +"builtinAssertionNamePrefix": { +"description": "Optional. The prefix to prepend to built-in assertion names.", +"type": "string" +}, +"databaseSuffix": { +"description": "Optional. The suffix that should be appended to all database (Google Cloud project ID) names.", +"type": "string" +}, +"defaultDatabase": { +"description": "Optional. The default database (Google Cloud project ID).", +"type": "string" +}, +"defaultLocation": { +"description": "Optional. The default BigQuery location to use. Defaults to \"US\". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.", +"type": "string" +}, +"defaultNotebookRuntimeOptions": { +"$ref": "NotebookRuntimeOptions", +"description": "Optional. The default notebook runtime options." +}, +"defaultSchema": { +"description": "Optional. The default schema (BigQuery dataset ID).", +"type": "string" +}, +"schemaSuffix": { +"description": "Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.", +"type": "string" +}, +"tablePrefix": { +"description": "Optional. The prefix that should be prepended to all table names.", +"type": "string" +}, +"vars": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-defined variables that are made available to project code during compilation.", +"type": "object" +} +}, +"type": "object" +}, +"ColumnDescriptor": { +"description": "Describes a column.", +"id": "ColumnDescriptor", +"properties": { +"bigqueryPolicyTags": { +"description": "A list of BigQuery policy tags that will be applied to the column.", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "A textual description of the column.", +"type": "string" +}, +"path": { +"description": "The identifier for the column. Each entry in `path` represents one level of nesting.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CommitAuthor": { +"description": "Represents the author of a Git commit.", +"id": "CommitAuthor", +"properties": { +"emailAddress": { +"description": "Required. The commit author's email address.", +"type": "string" +}, +"name": { +"description": "Required. The commit author's name.", +"type": "string" +} +}, +"type": "object" +}, +"CommitLogEntry": { +"description": "Represents a single commit log.", +"id": "CommitLogEntry", +"properties": { +"author": { +"$ref": "CommitAuthor", +"description": "The commit author for this commit log entry." +}, +"commitMessage": { +"description": "The commit message for this commit log entry.", +"type": "string" +}, +"commitSha": { +"description": "The commit SHA for this commit log entry.", +"type": "string" +}, +"commitTime": { +"description": "Commit timestamp.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"CommitMetadata": { +"description": "Represents a Dataform Git commit.", +"id": "CommitMetadata", +"properties": { +"author": { +"$ref": "CommitAuthor", +"description": "Required. The commit's author." +}, +"commitMessage": { +"description": "Optional. The commit's message.", +"type": "string" +} +}, +"type": "object" +}, +"CommitRepositoryChangesRequest": { +"description": "`CommitRepositoryChanges` request message.", +"id": "CommitRepositoryChangesRequest", +"properties": { +"commitMetadata": { +"$ref": "CommitMetadata", +"description": "Required. The changes to commit to the repository." +}, +"fileOperations": { +"additionalProperties": { +"$ref": "FileOperation" +}, +"description": "Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", +"type": "object" +}, +"requiredHeadCommitSha": { +"description": "Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.", +"type": "string" +} +}, +"type": "object" +}, +"CommitRepositoryChangesResponse": { +"description": "`CommitRepositoryChanges` response message.", +"id": "CommitRepositoryChangesResponse", +"properties": { +"commitSha": { +"description": "The commit SHA of the current commit.", +"type": "string" +} +}, +"type": "object" +}, +"CommitWorkspaceChangesRequest": { +"description": "`CommitWorkspaceChanges` request message.", +"id": "CommitWorkspaceChangesRequest", +"properties": { +"author": { +"$ref": "CommitAuthor", +"description": "Required. The commit's author." +}, +"commitMessage": { +"description": "Optional. The commit's message.", +"type": "string" +}, +"paths": { +"description": "Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CommitWorkspaceChangesResponse": { +"description": "`CommitWorkspaceChanges` response message.", +"id": "CommitWorkspaceChangesResponse", +"properties": {}, +"type": "object" +}, +"CompilationError": { +"description": "An error encountered when attempting to compile a Dataform project.", +"id": "CompilationError", +"properties": { +"actionTarget": { +"$ref": "Target", +"description": "Output only. The identifier of the action where this error occurred, if available.", +"readOnly": true +}, +"message": { +"description": "Output only. The error's top level message.", +"readOnly": true, +"type": "string" +}, +"path": { +"description": "Output only. The path of the file where this error occurred, if available, relative to the project root.", +"readOnly": true, +"type": "string" +}, +"stack": { +"description": "Output only. The error's full stack trace.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CompilationResult": { +"description": "Represents the result of compiling a Dataform project.", +"id": "CompilationResult", +"properties": { +"codeCompilationConfig": { +"$ref": "CodeCompilationConfig", +"description": "Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json." +}, +"compilationErrors": { +"description": "Output only. Errors encountered during project compilation.", +"items": { +"$ref": "CompilationError" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp of when the compilation result was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataEncryptionState": { +"$ref": "DataEncryptionState", +"description": "Output only. Only set if the repository has a KMS Key.", +"readOnly": true +}, +"dataformCoreVersion": { +"description": "Output only. The version of `@dataform/core` that was used for compilation.", +"readOnly": true, +"type": "string" +}, +"gitCommitish": { +"description": "Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`", +"type": "string" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The compilation result's name.", +"readOnly": true, +"type": "string" +}, +"releaseConfig": { +"description": "Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", +"type": "string" +}, +"resolvedGitCommitSha": { +"description": "Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.", +"readOnly": true, +"type": "string" +}, +"workspace": { +"description": "Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.", +"type": "string" +} +}, +"type": "object" +}, +"CompilationResultAction": { +"description": "Represents a single Dataform action in a compilation result.", +"id": "CompilationResultAction", +"properties": { +"assertion": { +"$ref": "Assertion", +"description": "The assertion executed by this action." +}, +"canonicalTarget": { +"$ref": "Target", +"description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." +}, +"dataPreparation": { +"$ref": "DataPreparation", +"description": "The data preparation executed by this action." +}, +"declaration": { +"$ref": "Declaration", +"description": "The declaration declared by this action." +}, +"filePath": { +"description": "The full path including filename in which this action is located, relative to the workspace root.", +"type": "string" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"notebook": { +"$ref": "Notebook", +"description": "The notebook executed by this action." +}, +"operations": { +"$ref": "Operations", +"description": "The database operations executed by this action." +}, +"relation": { +"$ref": "Relation", +"description": "The database relation created/updated by this action." +}, +"target": { +"$ref": "Target", +"description": "This action's identifier. Unique within the compilation result." +} +}, +"type": "object" +}, +"ComputeRepositoryAccessTokenStatusResponse": { +"description": "`ComputeRepositoryAccessTokenStatus` response message.", +"id": "ComputeRepositoryAccessTokenStatusResponse", +"properties": { +"tokenStatus": { +"description": "Indicates the status of the Git access token.", +"enum": [ +"TOKEN_STATUS_UNSPECIFIED", +"NOT_FOUND", +"INVALID", +"VALID" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The token could not be found in Secret Manager (or the Dataform Service Account did not have permission to access it).", +"The token could not be used to authenticate against the Git remote.", +"The token was used successfully to authenticate against the Git remote." +], +"type": "string" +} +}, +"type": "object" +}, +"Config": { +"description": "Config for all repositories in a given project and location.", +"id": "Config", +"properties": { +"defaultKmsKeyName": { +"description": "Optional. The default KMS key that is used if no encryption key is provided when a repository is created.", +"type": "string" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The config name.", +"type": "string" +} +}, +"type": "object" +}, +"DataEncryptionState": { +"description": "Describes encryption state of a resource.", +"id": "DataEncryptionState", +"properties": { +"kmsKeyVersionName": { +"description": "Required. The KMS key version name with which data of a resource is encrypted.", +"type": "string" +} +}, +"type": "object" +}, +"DataPreparation": { +"description": "Defines a compiled Data Preparation entity", +"id": "DataPreparation", +"properties": { +"contentsSql": { +"$ref": "SqlDefinition", +"description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." +}, +"contentsYaml": { +"description": "The data preparation definition, stored as a YAML string.", +"type": "string" +}, +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"DataPreparationAction": { +"description": "Represents a workflow action that will run a Data Preparation.", +"id": "DataPreparationAction", +"properties": { +"contentsSql": { +"$ref": "ActionSqlDefinition", +"description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." +}, +"contentsYaml": { +"description": "Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.", +"readOnly": true, +"type": "string" +}, +"generatedSql": { +"description": "Output only. The generated BigQuery SQL script that will be executed. For reference only.", +"readOnly": true, +"type": "string" +}, +"jobId": { +"description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Declaration": { +"description": "Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.", +"id": "Declaration", +"properties": { +"relationDescriptor": { +"$ref": "RelationDescriptor", +"description": "Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata." +} +}, +"type": "object" +}, +"DeleteFile": { +"description": "Represents the delete file operation.", +"id": "DeleteFile", +"properties": {}, +"type": "object" +}, +"DirectoryEntry": { +"description": "Represents a single entry in a directory.", +"id": "DirectoryEntry", +"properties": { +"directory": { +"description": "A child directory in the directory.", +"type": "string" +}, +"file": { +"description": "A file in the directory.", +"type": "string" +} +}, +"type": "object" +}, +"DirectorySearchResult": { +"description": "Client-facing representation of a directory entry in search results.", +"id": "DirectorySearchResult", +"properties": { +"path": { +"description": "File system path relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "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); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"ErrorTable": { +"description": "Error table information, used to write error data into a BigQuery table.", +"id": "ErrorTable", +"properties": { +"retentionDays": { +"description": "Error table partition expiration in days. Only positive values are allowed.", +"format": "int32", +"type": "integer" +}, +"target": { +"$ref": "Target", +"description": "Error Table target." +} +}, +"type": "object" +}, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"FetchFileDiffResponse": { +"description": "`FetchFileDiff` response message.", +"id": "FetchFileDiffResponse", +"properties": { +"formattedDiff": { +"description": "The raw formatted Git diff for the file.", +"type": "string" +} +}, +"type": "object" +}, +"FetchFileGitStatusesResponse": { +"description": "`FetchFileGitStatuses` response message.", +"id": "FetchFileGitStatusesResponse", +"properties": { +"uncommittedFileChanges": { +"description": "A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.", +"items": { +"$ref": "UncommittedFileChange" +}, +"type": "array" +} +}, +"type": "object" +}, +"FetchGitAheadBehindResponse": { +"description": "`FetchGitAheadBehind` response message.", +"id": "FetchGitAheadBehindResponse", +"properties": { +"commitsAhead": { +"description": "The number of commits in the remote branch that are not in the workspace.", +"format": "int32", +"type": "integer" +}, +"commitsBehind": { +"description": "The number of commits in the workspace that are not in the remote branch.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"FetchRemoteBranchesResponse": { +"description": "`FetchRemoteBranches` response message.", +"id": "FetchRemoteBranchesResponse", +"properties": { +"branches": { +"description": "The remote repository's branch names.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"FetchRepositoryHistoryResponse": { +"description": "`FetchRepositoryHistory` response message.", +"id": "FetchRepositoryHistoryResponse", +"properties": { +"commits": { +"description": "A list of commit logs, ordered by 'git log' default order.", +"items": { +"$ref": "CommitLogEntry" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"FileOperation": { +"description": "Represents a single file operation to the repository.", +"id": "FileOperation", +"properties": { +"deleteFile": { +"$ref": "DeleteFile", +"description": "Represents the delete operation." +}, +"writeFile": { +"$ref": "WriteFile", +"description": "Represents the write operation." +} +}, +"type": "object" +}, +"FileSearchResult": { +"description": "Client-facing representation of a file entry in search results.", +"id": "FileSearchResult", +"properties": { +"path": { +"description": "File system path relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"GitRemoteSettings": { +"description": "Controls Git remote configuration for a repository.", +"id": "GitRemoteSettings", +"properties": { +"authenticationTokenSecretVersion": { +"description": "Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.", +"type": "string" +}, +"defaultBranch": { +"description": "Required. The Git remote's default branch name.", +"type": "string" +}, +"sshAuthenticationConfig": { +"$ref": "SshAuthenticationConfig", +"description": "Optional. Authentication fields for remote uris using SSH protocol." +}, +"tokenStatus": { +"deprecated": true, +"description": "Output only. Deprecated: The field does not contain any token status information.", +"enum": [ +"TOKEN_STATUS_UNSPECIFIED", +"NOT_FOUND", +"INVALID", +"VALID" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The token could not be found in Secret Manager (or the Dataform Service Account did not have permission to access it).", +"The token could not be used to authenticate against the Git remote.", +"The token was used successfully to authenticate against the Git remote." +], +"readOnly": true, +"type": "string" +}, +"url": { +"description": "Required. The Git remote's URL.", +"type": "string" +} +}, +"type": "object" +}, +"IamPolicyOverrideView": { +"description": "Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders.", +"id": "IamPolicyOverrideView", +"properties": { +"iamPolicyName": { +"$ref": "PolicyName", +"description": "The IAM policy name for the resource." +}, +"isActive": { +"description": "Whether the IAM policy encoded in this view is active.", +"type": "boolean" +} +}, +"type": "object" +}, +"IncrementalLoadMode": { +"description": "Load definition for incremental load modes", +"id": "IncrementalLoadMode", +"properties": { +"column": { +"description": "Column name for incremental load modes", +"type": "string" +} +}, +"type": "object" +}, +"IncrementalTableConfig": { +"description": "Contains settings for relations of type `INCREMENTAL_TABLE`.", +"id": "IncrementalTableConfig", +"properties": { +"incrementalPostOperations": { +"description": "SQL statements to be executed after inserting new rows into the relation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"incrementalPreOperations": { +"description": "SQL statements to be executed before inserting new rows into the relation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"incrementalSelectQuery": { +"description": "The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed.", +"type": "string" +}, +"refreshDisabled": { +"description": "Whether this table should be protected from being refreshed.", +"type": "boolean" +}, +"uniqueKeyParts": { +"description": "A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"updatePartitionFilter": { +"description": "A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information).", +"type": "string" +} +}, +"type": "object" +}, +"InstallNpmPackagesRequest": { +"description": "`InstallNpmPackages` request message.", +"id": "InstallNpmPackagesRequest", +"properties": {}, +"type": "object" +}, +"InstallNpmPackagesResponse": { +"description": "`InstallNpmPackages` response message.", +"id": "InstallNpmPackagesResponse", +"properties": {}, +"type": "object" +}, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"InvocationConfig": { +"description": "Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.", +"id": "InvocationConfig", +"properties": { +"fullyRefreshIncrementalTablesEnabled": { +"description": "Optional. When set to true, any incremental tables will be fully refreshed.", +"type": "boolean" +}, +"includedTags": { +"description": "Optional. The set of tags to include.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includedTargets": { +"description": "Optional. The set of action identifiers to include.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"queryPriority": { +"description": "Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.", +"enum": [ +"QUERY_PRIORITY_UNSPECIFIED", +"INTERACTIVE", +"BATCH" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Query will be executed in BigQuery with interactive priority. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.", +"Query will be executed in BigQuery with batch priority. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#batchqueries." +], +"type": "string" +}, +"serviceAccount": { +"description": "Optional. The service account to run workflow invocations under.", +"type": "string" +}, +"transitiveDependenciesIncluded": { +"description": "Optional. When set to true, transitive dependencies of included actions will be executed.", +"type": "boolean" +}, +"transitiveDependentsIncluded": { +"description": "Optional. When set to true, transitive dependents of included actions will be executed.", +"type": "boolean" +} +}, +"type": "object" +}, +"ListCompilationResultsResponse": { +"description": "`ListCompilationResults` response message.", +"id": "ListCompilationResultsResponse", +"properties": { +"compilationResults": { +"description": "List of compilation results.", +"items": { +"$ref": "CompilationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListReleaseConfigsResponse": { +"description": "`ListReleaseConfigs` response message.", +"id": "ListReleaseConfigsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"releaseConfigs": { +"description": "List of release configs.", +"items": { +"$ref": "ReleaseConfig" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListRepositoriesResponse": { +"description": "`ListRepositories` response message.", +"id": "ListRepositoriesResponse", +"properties": { +"nextPageToken": { +"description": "A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"repositories": { +"description": "List of repositories.", +"items": { +"$ref": "Repository" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListWorkflowConfigsResponse": { +"description": "`ListWorkflowConfigs` response message.", +"id": "ListWorkflowConfigsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"workflowConfigs": { +"description": "List of workflow configs.", +"items": { +"$ref": "WorkflowConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListWorkflowInvocationsResponse": { +"description": "`ListWorkflowInvocations` response message.", +"id": "ListWorkflowInvocationsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"workflowInvocations": { +"description": "List of workflow invocations.", +"items": { +"$ref": "WorkflowInvocation" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListWorkspacesResponse": { +"description": "`ListWorkspaces` response message.", +"id": "ListWorkspacesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations which could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"workspaces": { +"description": "List of workspaces.", +"items": { +"$ref": "Workspace" +}, +"type": "array" +} +}, +"type": "object" +}, +"LoadConfig": { +"description": "Simplified load configuration for actions", +"id": "LoadConfig", +"properties": { +"append": { +"$ref": "SimpleLoadMode", +"description": "Append into destination table" +}, +"maximum": { +"$ref": "IncrementalLoadMode", +"description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" +}, +"replace": { +"$ref": "SimpleLoadMode", +"description": "Replace destination table" +}, +"unique": { +"$ref": "IncrementalLoadMode", +"description": "Insert records where the value of a column is not already present in the destination table" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"MakeDirectoryRequest": { +"description": "`MakeDirectory` request message.", +"id": "MakeDirectoryRequest", +"properties": { +"path": { +"description": "Required. The directory's full path including directory name, relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"MakeDirectoryResponse": { +"description": "`MakeDirectory` response message.", +"id": "MakeDirectoryResponse", +"properties": {}, +"type": "object" +}, +"MoveDirectoryRequest": { +"description": "`MoveDirectory` request message.", +"id": "MoveDirectoryRequest", +"properties": { +"newPath": { +"description": "Required. The new path for the directory including directory name, rooted at workspace root.", +"type": "string" +}, +"path": { +"description": "Required. The directory's full path including directory name, relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"MoveDirectoryResponse": { +"description": "`MoveDirectory` response message.", +"id": "MoveDirectoryResponse", +"properties": {}, +"type": "object" +}, +"MoveFileRequest": { +"description": "`MoveFile` request message.", +"id": "MoveFileRequest", +"properties": { +"newPath": { +"description": "Required. The file's new path including filename, relative to the workspace root.", +"type": "string" +}, +"path": { +"description": "Required. The file's full path including filename, relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"MoveFileResponse": { +"description": "`MoveFile` response message.", +"id": "MoveFileResponse", +"properties": {}, +"type": "object" +}, +"Notebook": { +"description": "Represents a notebook.", +"id": "Notebook", +"properties": { +"contents": { +"description": "The contents of the notebook.", +"type": "string" +}, +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"NotebookAction": { +"description": "Represents a workflow action that will run against a Notebook runtime.", +"id": "NotebookAction", +"properties": { +"contents": { +"description": "Output only. The code contents of a Notebook to be run.", +"readOnly": true, +"type": "string" +}, +"jobId": { +"description": "Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NotebookRuntimeOptions": { +"description": "Configures various aspects of Dataform notebook runtime.", +"id": "NotebookRuntimeOptions", +"properties": { +"aiPlatformNotebookRuntimeTemplate": { +"description": "Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.", +"type": "string" +}, +"gcsOutputBucket": { +"description": "Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.", +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "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.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "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.", +"type": "object" +}, +"name": { +"description": "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}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "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`.", +"type": "object" +} +}, +"type": "object" +}, +"OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"cancelRequested": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"statusDetail": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Operations": { +"description": "Represents a list of arbitrary database operations.", +"id": "Operations", +"properties": { +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"hasOutput": { +"description": "Whether these operations produce an output relation.", +"type": "boolean" +}, +"queries": { +"description": "A list of arbitrary SQL statements that will be executed without alteration.", +"items": { +"type": "string" +}, +"type": "array" +}, +"relationDescriptor": { +"$ref": "RelationDescriptor", +"description": "Descriptor for any output relation and its columns. Only set if `has_output` is true." +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"PolicyName": { +"description": "An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.", +"id": "PolicyName", +"properties": { +"id": { +"description": "Identifies an instance of the type. ID format varies by type. The ID format is defined in the IAM .service file that defines the type, either in path_mapping or in a comment.", +"type": "string" +}, +"region": { +"description": "For Cloud IAM: The location of the Policy. Must be empty or \"global\" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to \"local\".", +"type": "string" +}, +"type": { +"description": "Resource type. Types are defined in IAM's .service files. Valid values for type might be 'storage_buckets', 'compute_instances', 'resourcemanager_customers', 'billing_accounts', etc.", +"type": "string" +} +}, +"type": "object" +}, +"PullGitCommitsRequest": { +"description": "`PullGitCommits` request message.", +"id": "PullGitCommitsRequest", +"properties": { +"author": { +"$ref": "CommitAuthor", +"description": "Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace." +}, +"remoteBranch": { +"description": "Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.", +"type": "string" +} +}, +"type": "object" +}, +"PullGitCommitsResponse": { +"description": "`PullGitCommits` response message.", +"id": "PullGitCommitsResponse", +"properties": {}, +"type": "object" +}, +"PushGitCommitsRequest": { +"description": "`PushGitCommits` request message.", +"id": "PushGitCommitsRequest", +"properties": { +"remoteBranch": { +"description": "Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.", +"type": "string" +} +}, +"type": "object" +}, +"PushGitCommitsResponse": { +"description": "`PushGitCommits` response message.", +"id": "PushGitCommitsResponse", +"properties": {}, +"type": "object" +}, +"QueryCompilationResultActionsResponse": { +"description": "`QueryCompilationResultActions` response message.", +"id": "QueryCompilationResultActionsResponse", +"properties": { +"compilationResultActions": { +"description": "List of compilation result actions.", +"items": { +"$ref": "CompilationResultAction" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryDirectoryContentsResponse": { +"description": "`QueryDirectoryContents` response message.", +"id": "QueryDirectoryContentsResponse", +"properties": { +"directoryEntries": { +"description": "List of entries in the directory.", +"items": { +"$ref": "DirectoryEntry" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryRepositoryDirectoryContentsResponse": { +"description": "`QueryRepositoryDirectoryContents` response message.", +"id": "QueryRepositoryDirectoryContentsResponse", +"properties": { +"directoryEntries": { +"description": "List of entries in the directory.", +"items": { +"$ref": "DirectoryEntry" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryWorkflowInvocationActionsResponse": { +"description": "`QueryWorkflowInvocationActions` response message.", +"id": "QueryWorkflowInvocationActionsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"workflowInvocationActions": { +"description": "List of workflow invocation actions.", +"items": { +"$ref": "WorkflowInvocationAction" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReadFileResponse": { +"description": "`ReadFile` response message.", +"id": "ReadFileResponse", +"properties": { +"fileContents": { +"description": "The file's contents.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"ReadRepositoryFileResponse": { +"description": "`ReadRepositoryFile` response message.", +"id": "ReadRepositoryFileResponse", +"properties": { +"contents": { +"description": "The file's contents.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"Relation": { +"description": "Represents a database relation.", +"id": "Relation", +"properties": { +"additionalOptions": { +"additionalProperties": { +"type": "string" +}, +"description": "Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.", +"type": "object" +}, +"clusterExpressions": { +"description": "A list of columns or SQL expressions used to cluster the table.", +"items": { +"type": "string" +}, +"type": "array" +}, +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"incrementalTableConfig": { +"$ref": "IncrementalTableConfig", +"description": "Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`." +}, +"partitionExpirationDays": { +"description": "Sets the partition expiration in days.", +"format": "int32", +"type": "integer" +}, +"partitionExpression": { +"description": "The SQL expression used to partition the relation.", +"type": "string" +}, +"postOperations": { +"description": "SQL statements to be executed after creating the relation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"preOperations": { +"description": "SQL statements to be executed before creating the relation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"relationDescriptor": { +"$ref": "RelationDescriptor", +"description": "Descriptor for the relation and its columns." +}, +"relationType": { +"description": "The type of this relation.", +"enum": [ +"RELATION_TYPE_UNSPECIFIED", +"TABLE", +"VIEW", +"INCREMENTAL_TABLE", +"MATERIALIZED_VIEW" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The relation is a table.", +"The relation is a view.", +"The relation is an incrementalized table.", +"The relation is a materialized view." +], +"type": "string" +}, +"requirePartitionFilter": { +"description": "Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.", +"type": "boolean" +}, +"selectQuery": { +"description": "The SELECT query which returns rows which this relation should contain.", +"type": "string" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"RelationDescriptor": { +"description": "Describes a relation and its columns.", +"id": "RelationDescriptor", +"properties": { +"bigqueryLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "A set of BigQuery labels that should be applied to the relation.", +"type": "object" +}, +"columns": { +"description": "A list of descriptions of columns within the relation.", +"items": { +"$ref": "ColumnDescriptor" +}, +"type": "array" +}, +"description": { +"description": "A text description of the relation.", +"type": "string" +} +}, +"type": "object" +}, +"ReleaseConfig": { +"description": "Represents a Dataform release configuration.", +"id": "ReleaseConfig", +"properties": { +"codeCompilationConfig": { +"$ref": "CodeCompilationConfig", +"description": "Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json." +}, +"cronSchedule": { +"description": "Optional. Optional schedule (in cron format) for automatic creation of compilation results.", +"type": "string" +}, +"disabled": { +"description": "Optional. Disables automatic creation of compilation results.", +"type": "boolean" +}, +"gitCommitish": { +"description": "Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`", +"type": "string" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The release config's name.", +"type": "string" +}, +"recentScheduledReleaseRecords": { +"description": "Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.", +"items": { +"$ref": "ScheduledReleaseRecord" +}, +"readOnly": true, +"type": "array" +}, +"releaseCompilationResult": { +"description": "Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", +"type": "string" +}, +"timeZone": { +"description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.", +"type": "string" +} +}, +"type": "object" +}, +"RemoveDirectoryRequest": { +"description": "`RemoveDirectory` request message.", +"id": "RemoveDirectoryRequest", +"properties": { +"path": { +"description": "Required. The directory's full path including directory name, relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"RemoveDirectoryResponse": { +"description": "`RemoveDirectory` response message.", +"id": "RemoveDirectoryResponse", +"properties": {}, +"type": "object" +}, +"RemoveFileRequest": { +"description": "`RemoveFile` request message.", +"id": "RemoveFileRequest", +"properties": { +"path": { +"description": "Required. The file's full path including filename, relative to the workspace root.", +"type": "string" +} +}, +"type": "object" +}, +"RemoveFileResponse": { +"description": "`RemoveFile` response message.", +"id": "RemoveFileResponse", +"properties": {}, +"type": "object" +}, +"Repository": { +"description": "Represents a Dataform Git repository.", +"id": "Repository", +"properties": { +"createTime": { +"description": "Output only. The timestamp of when the repository was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataEncryptionState": { +"$ref": "DataEncryptionState", +"description": "Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.", +"readOnly": true +}, +"displayName": { +"description": "Optional. The repository's user-friendly name.", +"type": "string" +}, +"gitRemoteSettings": { +"$ref": "GitRemoteSettings", +"description": "Optional. If set, configures this repository to be linked to a Git remote." +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"kmsKeyName": { +"description": "Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Repository user labels.", +"type": "object" +}, +"name": { +"description": "Identifier. The repository's name.", +"type": "string" +}, +"npmrcEnvironmentVariablesSecretVersion": { +"description": "Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.", +"type": "string" +}, +"serviceAccount": { +"description": "Optional. The service account to run workflow invocations under.", +"type": "string" +}, +"setAuthenticatedUserAdmin": { +"description": "Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.", +"type": "boolean" +}, +"workspaceCompilationOverrides": { +"$ref": "WorkspaceCompilationOverrides", +"description": "Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information." +} +}, +"type": "object" +}, +"ResetWorkspaceChangesRequest": { +"description": "`ResetWorkspaceChanges` request message.", +"id": "ResetWorkspaceChangesRequest", +"properties": { +"clean": { +"description": "Optional. If set to true, untracked files will be deleted.", +"type": "boolean" +}, +"paths": { +"description": "Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ResetWorkspaceChangesResponse": { +"description": "`ResetWorkspaceChanges` response message.", +"id": "ResetWorkspaceChangesResponse", +"properties": {}, +"type": "object" +}, +"ScheduledExecutionRecord": { +"description": "A record of an attempt to create a workflow invocation for this workflow config.", +"id": "ScheduledExecutionRecord", +"properties": { +"errorStatus": { +"$ref": "Status", +"description": "The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful." +}, +"executionTime": { +"description": "Output only. The timestamp of this execution attempt.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workflowInvocation": { +"description": "The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.", +"type": "string" +} +}, +"type": "object" +}, +"ScheduledReleaseRecord": { +"description": "A record of an attempt to create a compilation result for this release config.", +"id": "ScheduledReleaseRecord", +"properties": { +"compilationResult": { +"description": "The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", +"type": "string" +}, +"errorStatus": { +"$ref": "Status", +"description": "The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful." +}, +"releaseTime": { +"description": "Output only. The timestamp of this release attempt.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SearchFilesResponse": { +"description": "Client-facing representation of a file search response.", +"id": "SearchFilesResponse", +"properties": { +"nextPageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"searchResults": { +"description": "List of matched results.", +"items": { +"$ref": "SearchResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"SearchResult": { +"description": "Client-facing representation of a search result entry.", +"id": "SearchResult", +"properties": { +"directory": { +"$ref": "DirectorySearchResult", +"description": "Details when search result is a directory." +}, +"file": { +"$ref": "FileSearchResult", +"description": "Details when search result is a file." +} +}, +"type": "object" +}, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +} +}, +"type": "object" +}, +"SimpleLoadMode": { +"description": "Simple load definition", +"id": "SimpleLoadMode", +"properties": {}, +"type": "object" +}, +"SqlDefinition": { +"description": "Definition of a SQL Data Preparation", +"id": "SqlDefinition", +"properties": { +"errorTable": { +"$ref": "ErrorTable", +"description": "Error table configuration," +}, +"load": { +"$ref": "LoadConfig", +"description": "Load configuration." +}, +"query": { +"description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", +"type": "string" +} +}, +"type": "object" +}, +"SshAuthenticationConfig": { +"description": "Configures fields for performing SSH authentication.", +"id": "SshAuthenticationConfig", +"properties": { +"hostPublicKey": { +"description": "Required. Content of a public SSH key to verify an identity of a remote Git host.", +"type": "string" +}, +"userPrivateKeySecretVersion": { +"description": "Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.", +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "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).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "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.", +"type": "string" +} +}, +"type": "object" +}, +"Target": { +"description": "Represents an action identifier. If the action writes output, the output will be written to the referenced database object.", +"id": "Target", +"properties": { +"database": { +"description": "Optional. The action's database (Google Cloud project ID) .", +"type": "string" +}, +"name": { +"description": "Optional. The action's name, within `database` and `schema`.", +"type": "string" +}, +"schema": { +"description": "Optional. The action's schema (BigQuery dataset ID), within `database`.", +"type": "string" +} +}, +"type": "object" +}, +"TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"UncommittedFileChange": { +"description": "Represents the Git state of a file with uncommitted changes.", +"id": "UncommittedFileChange", +"properties": { +"path": { +"description": "The file's full path including filename, relative to the workspace root.", +"type": "string" +}, +"state": { +"description": "Output only. Indicates the status of the file.", +"enum": [ +"STATE_UNSPECIFIED", +"ADDED", +"DELETED", +"MODIFIED", +"HAS_CONFLICTS" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The file has been newly added.", +"The file has been deleted.", +"The file has been modified.", +"The file contains merge conflicts." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WorkflowConfig": { +"description": "Represents a Dataform workflow configuration.", +"id": "WorkflowConfig", +"properties": { +"createTime": { +"description": "Output only. The timestamp of when the WorkflowConfig was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cronSchedule": { +"description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.", +"type": "string" +}, +"disabled": { +"description": "Optional. Disables automatic creation of workflow invocations.", +"type": "boolean" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"invocationConfig": { +"$ref": "InvocationConfig", +"description": "Optional. If left unset, a default InvocationConfig will be used." +}, +"name": { +"description": "Identifier. The workflow config's name.", +"type": "string" +}, +"recentScheduledExecutionRecords": { +"description": "Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.", +"items": { +"$ref": "ScheduledExecutionRecord" +}, +"readOnly": true, +"type": "array" +}, +"releaseConfig": { +"description": "Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", +"type": "string" +}, +"timeZone": { +"description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp of when the WorkflowConfig was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WorkflowInvocation": { +"description": "Represents a single invocation of a compilation result.", +"id": "WorkflowInvocation", +"properties": { +"compilationResult": { +"description": "Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", +"type": "string" +}, +"dataEncryptionState": { +"$ref": "DataEncryptionState", +"description": "Output only. Only set if the repository has a KMS Key.", +"readOnly": true +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"invocationConfig": { +"$ref": "InvocationConfig", +"description": "Immutable. If left unset, a default InvocationConfig will be used." +}, +"invocationTiming": { +"$ref": "Interval", +"description": "Output only. This workflow invocation's timing details.", +"readOnly": true +}, +"name": { +"description": "Output only. The workflow invocation's name.", +"readOnly": true, +"type": "string" +}, +"resolvedCompilationResult": { +"description": "Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. This workflow invocation's current state.", +"enum": [ +"STATE_UNSPECIFIED", +"RUNNING", +"SUCCEEDED", +"CANCELLED", +"FAILED", +"CANCELING" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The workflow invocation is currently running.", +"The workflow invocation succeeded. A terminal state.", +"The workflow invocation was cancelled. A terminal state.", +"The workflow invocation failed. A terminal state.", +"The workflow invocation is being cancelled, but some actions are still running." +], +"readOnly": true, +"type": "string" +}, +"workflowConfig": { +"description": "Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.", +"type": "string" +} +}, +"type": "object" +}, +"WorkflowInvocationAction": { +"description": "Represents a single action in a workflow invocation.", +"id": "WorkflowInvocationAction", +"properties": { +"bigqueryAction": { +"$ref": "BigQueryAction", +"description": "Output only. The workflow action's bigquery action details.", +"readOnly": true +}, +"canonicalTarget": { +"$ref": "Target", +"description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.", +"readOnly": true +}, +"dataPreparationAction": { +"$ref": "DataPreparationAction", +"description": "Output only. The workflow action's data preparation action details.", +"readOnly": true +}, +"failureReason": { +"description": "Output only. If and only if action's state is FAILED a failure reason is set.", +"readOnly": true, +"type": "string" +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"invocationTiming": { +"$ref": "Interval", +"description": "Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.", +"readOnly": true +}, +"notebookAction": { +"$ref": "NotebookAction", +"description": "Output only. The workflow action's notebook action details.", +"readOnly": true +}, +"state": { +"description": "Output only. This action's current state.", +"enum": [ +"PENDING", +"RUNNING", +"SKIPPED", +"DISABLED", +"SUCCEEDED", +"CANCELLED", +"FAILED" +], +"enumDescriptions": [ +"The action has not yet been considered for invocation.", +"The action is currently running.", +"Execution of the action was skipped because upstream dependencies did not all complete successfully. A terminal state.", +"Execution of the action was disabled as per the configuration of the corresponding compilation result action. A terminal state.", +"The action succeeded. A terminal state.", +"The action was cancelled. A terminal state.", +"The action failed. A terminal state." +], +"readOnly": true, +"type": "string" +}, +"target": { +"$ref": "Target", +"description": "Output only. This action's identifier. Unique within the workflow invocation.", +"readOnly": true +} +}, +"type": "object" +}, +"Workspace": { +"description": "Represents a Dataform Git workspace.", +"id": "Workspace", +"properties": { +"createTime": { +"description": "Output only. The timestamp of when the workspace was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataEncryptionState": { +"$ref": "DataEncryptionState", +"description": "Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.", +"readOnly": true +}, +"internalMetadata": { +"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The workspace's name.", +"type": "string" +} +}, +"type": "object" +}, +"WorkspaceCompilationOverrides": { +"description": "Configures workspace compilation overrides for a repository.", +"id": "WorkspaceCompilationOverrides", +"properties": { +"defaultDatabase": { +"description": "Optional. The default database (Google Cloud project ID).", +"type": "string" +}, +"schemaSuffix": { +"description": "Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.", +"type": "string" +}, +"tablePrefix": { +"description": "Optional. The prefix that should be prepended to all table names.", +"type": "string" +} +}, +"type": "object" +}, +"WriteFile": { +"description": "Represents the write file operation (for files added or modified).", +"id": "WriteFile", +"properties": { +"contents": { +"description": "The file's contents.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"WriteFileRequest": { +"description": "`WriteFile` request message.", +"id": "WriteFileRequest", +"properties": { +"contents": { +"description": "Required. The file's contents.", +"format": "byte", +"type": "string" +}, +"path": { +"description": "Required. The file.", +"type": "string" +} +}, +"type": "object" +}, +"WriteFileResponse": { +"description": "`WriteFile` response message.", +"id": "WriteFileResponse", +"properties": {}, +"type": "object" +} +}, +"servicePath": "", +"title": "Dataform API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 4f1f5bd99d..291e3ab7ef 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -68,6 +68,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataplex.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, @@ -113,6 +118,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataplex.europe-west2.rep.googleapis.com/", "location": "europe-west2" }, @@ -860,7 +870,7 @@ "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", -"Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." +"" ], "location": "query", "type": "string" @@ -3062,7 +3072,7 @@ "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", -"Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." +"" ], "location": "query", "type": "string" @@ -7250,7 +7260,7 @@ } } }, -"revision": "20250924", +"revision": "20251012", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -7544,6 +7554,18 @@ "readOnly": true, "type": "string" }, +"dataClassification": { +"description": "Optional. Immutable. Stores data classification of the aspect.", +"enum": [ +"DATA_CLASSIFICATION_UNSPECIFIED", +"METADATA_AND_DATA" +], +"enumDescriptions": [ +"Denotes that the aspect contains only metadata.", +"Metadata and data classification." +], +"type": "string" +}, "description": { "description": "Optional. Description of the AspectType.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index dc58f51c40..da46b8d03a 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -1613,6 +1613,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -4636,6 +4641,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -5012,7 +5022,7 @@ } } }, -"revision": "20251001", +"revision": "20251003", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -7083,7 +7093,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)).", +"description": "Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags in Dataproc (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)).", "type": "object" }, "serviceAccount": { @@ -8391,6 +8401,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -12591,11 +12608,11 @@ "id": "UsageMetrics", "properties": { "acceleratorType": { -"description": "Optional. Accelerator type being used, if any", +"description": "Optional. DEPRECATED Accelerator type being used, if any", "type": "string" }, "milliAcceleratorSeconds": { -"description": "Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", +"description": "Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", "format": "int64", "type": "string" }, @@ -13005,6 +13022,11 @@ "description": "A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", "id": "YarnApplication", "properties": { +"memoryMbSeconds": { +"description": "Optional. The cumulative memory usage of the application for a job, measured in mb-seconds.", +"format": "int64", +"type": "string" +}, "name": { "description": "Required. The application name.", "type": "string" @@ -13043,6 +13065,11 @@ "trackingUrl": { "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.", "type": "string" +}, +"vcoreSeconds": { +"description": "Optional. The cumulative CPU time consumed by the application for a job, measured in vcore-seconds.", +"format": "int64", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index b956cbc7a0..a650eadd08 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -467,6 +467,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://datastore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -1111,7 +1121,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json index 48c9ee15ee..74fcf145f7 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -467,6 +467,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://datastore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -620,7 +630,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index cc2d19d944..10cbf48ec2 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -467,6 +467,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://datastore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -788,7 +798,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json index 57b097e46a..af9ea5235c 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json @@ -4675,11 +4675,81 @@ "scopes": [ "https://www.googleapis.com/auth/dfatrafficking" ] +}, +"retransform": { +"description": "Retransforms a dynamic feed.", +"flatPath": "studio/dynamicFeeds/{dynamicFeedsId}/retransform", +"httpMethod": "POST", +"id": "dfareporting.dynamicFeeds.retransform", +"parameterOrder": [ +"dynamicFeedId" +], +"parameters": { +"dynamicFeedId": { +"description": "Required. Dynamic feed ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicFeeds/{+dynamicFeedId}/retransform", +"response": { +"$ref": "DynamicFeed" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"update": { +"description": "Updates a new dynamic feed.", +"flatPath": "studio/dynamicFeeds", +"httpMethod": "PUT", +"id": "dfareporting.dynamicFeeds.update", +"parameterOrder": [], +"parameters": {}, +"path": "studio/dynamicFeeds", +"request": { +"$ref": "DynamicFeed" +}, +"response": { +"$ref": "DynamicFeed" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] } } }, "dynamicProfiles": { "methods": { +"generateCode": { +"description": "Generates code for a dynamic profile.", +"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/generateCode", +"httpMethod": "GET", +"id": "dfareporting.dynamicProfiles.generateCode", +"parameterOrder": [ +"dynamicProfileId" +], +"parameters": { +"dynamicProfileId": { +"description": "Required. Dynamic profile ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicProfiles/{+dynamicProfileId}/generateCode", +"response": { +"$ref": "DynamicProfileGenerateCodeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, "get": { "description": "Gets a dynamic profile by ID.", "flatPath": "studio/dynamicProfiles/{dynamicProfilesId}", @@ -4724,6 +4794,29 @@ "https://www.googleapis.com/auth/dfatrafficking" ] }, +"publish": { +"description": "Publish for a dynamic profile.", +"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/publish", +"httpMethod": "POST", +"id": "dfareporting.dynamicProfiles.publish", +"parameterOrder": [ +"dynamicProfileId" +], +"parameters": { +"dynamicProfileId": { +"description": "Required. Dynamic profile ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicProfiles/{+dynamicProfileId}/publish", +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, "update": { "description": "Updates an existing dynamic profile.", "flatPath": "studio/dynamicProfiles", @@ -9122,6 +9215,112 @@ } } }, +"studioCreativeAssets": { +"methods": { +"insert": { +"description": "Inserts a new studio creative asset.", +"flatPath": "studio/creativeAssets", +"httpMethod": "POST", +"id": "dfareporting.studioCreativeAssets.insert", +"mediaUpload": { +"accept": [ +"*/*" +], +"maxSize": "1073741824", +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/dfareporting/v4/studio/creativeAssets" +} +} +}, +"parameterOrder": [], +"parameters": {}, +"path": "studio/creativeAssets", +"request": { +"$ref": "DfareportingStudioCreativeAssetsInsertRequest" +}, +"response": { +"$ref": "StudioCreativeAssetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +], +"supportsMediaUpload": true +} +} +}, +"studioCreatives": { +"methods": { +"get": { +"description": "Gets a studio creative by ID.", +"flatPath": "studio/creatives/{creativesId}", +"httpMethod": "GET", +"id": "dfareporting.studioCreatives.get", +"parameterOrder": [ +"studioCreativeId" +], +"parameters": { +"studioCreativeId": { +"description": "Required. Studio creative ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/creatives/{+studioCreativeId}", +"response": { +"$ref": "StudioCreative" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"insert": { +"description": "Inserts a new studio creative.", +"flatPath": "studio/creatives", +"httpMethod": "POST", +"id": "dfareporting.studioCreatives.insert", +"parameterOrder": [], +"parameters": {}, +"path": "studio/creatives", +"request": { +"$ref": "StudioCreative" +}, +"response": { +"$ref": "StudioCreative" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"publish": { +"description": "Publish for a studio creative.", +"flatPath": "studio/creatives/{creativesId}/publish", +"httpMethod": "POST", +"id": "dfareporting.studioCreatives.publish", +"parameterOrder": [ +"studioCreativeId" +], +"parameters": { +"studioCreativeId": { +"description": "Required. Studio creative ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/creatives/{+studioCreativeId}/publish", +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +} +} +}, "subaccounts": { "methods": { "get": { @@ -10266,7 +10465,7 @@ } } }, -"revision": "20250902", +"revision": "20251009", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12760,14 +12959,18 @@ "CREATIVE_AUTHORING_SOURCE_DBM", "CREATIVE_AUTHORING_SOURCE_STUDIO", "CREATIVE_AUTHORING_SOURCE_GWD", -"CREATIVE_AUTHORING_SOURCE_ACS" +"CREATIVE_AUTHORING_SOURCE_ACS", +"CREATIVE_AUTHORING_SOURCE_ADOBE", +"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", "DBM-UI used to author the creative.", "Studio-UI used to author the creative.", "Google Web Designer used to author the creative.", -"ACS-UI used to author the creative." +"ACS-UI used to author the creative.", +"Creative authoring source is Adobe.", +"Creative authoring source is Typeface.ai." ], "type": "string" }, @@ -15194,6 +15397,28 @@ }, "type": "object" }, +"DfareportingStudioCreativeAssetsInsertRequest": { +"description": "Request message for DfareportingStudioCreativeAssets.Insert.", +"id": "DfareportingStudioCreativeAssetsInsertRequest", +"properties": { +"studioAccountId": { +"description": "Optional. Studio account ID of the studio creative asset. It is a optional.", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Required. Studio advertiser ID of the studio creative asset. It is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCreativeId": { +"description": "Optional. Studio creative ID of the studio creative asset. It is a optional field. If it is set, the asset will be associated to the creative.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "DfpSettings": { "description": "Google Ad Manager Settings", "id": "DfpSettings", @@ -15545,7 +15770,7 @@ "type": "object" }, "DynamicFeedsInsertRequest": { -"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface", +"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See", "id": "DynamicFeedsInsertRequest", "properties": { "dynamicFeed": { @@ -15660,6 +15885,17 @@ }, "type": "object" }, +"DynamicProfileGenerateCodeResponse": { +"description": "Response message for DfareportingDynamicProfiles.GenerateCode.", +"id": "DynamicProfileGenerateCodeResponse", +"properties": { +"code": { +"description": "Generated code for the dynamic profile.", +"type": "string" +} +}, +"type": "object" +}, "DynamicProfileVersion": { "description": "Contains dynamic profile version information.", "id": "DynamicProfileVersion", @@ -21361,6 +21597,207 @@ }, "type": "object" }, +"StudioCreative": { +"description": "Contains studio creative information.", +"id": "StudioCreative", +"properties": { +"assetIds": { +"description": "List of assets associated with this studio creative. It is a required field on insertion.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"backupImageAssetId": { +"description": "Backup image asset ID of this studio creative.", +"format": "int64", +"type": "string" +}, +"createdInfo": { +"$ref": "LastModifiedInfo", +"description": "The timestamp when the studio creative was created. This is a read-only, auto-generated field." +}, +"dimension": { +"$ref": "StudioCreativeDimension", +"description": "Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING." +}, +"dynamicProfileId": { +"description": "Dynamic profile ID of this studio creative.", +"format": "int64", +"type": "string" +}, +"format": { +"description": "Format of this studio creative. This is a required field on insertion.", +"enum": [ +"UNKNOWN", +"BANNER", +"EXPANDING", +"INTERSTITIAL", +"VPAID_LINEAR_VIDEO" +], +"enumDescriptions": [ +"The format of the studio creative is unknown. This value is unused.", +"Banner format.", +"Expanding format.", +"Intertitial format.", +"VPAID linear video creative format." +], +"type": "string" +}, +"id": { +"description": "Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lastModifiedInfo": { +"$ref": "LastModifiedInfo", +"description": "The timestamp when the studio creative was last modified. This is a read-only, auto-generated field." +}, +"name": { +"description": "Identifier. Name of this studio creative. This is a required field on insertion.", +"type": "string" +}, +"status": { +"description": "Output only. Status of this studio creative. It is a read-only field.", +"enum": [ +"UNKNOWN_STATUS", +"IN_DEVELOPMENT", +"PUBLISHED", +"QA_REJECTED", +"QA_APPROVED", +"TRAFFICKED" +], +"enumDescriptions": [ +"The status of the studio creative is unknown. This value is unused.", +"The creative is still being developed.", +"The creative has been published and is ready for QA.", +"The creative has failed QA and must be corrected.", +"The creative has passed QA and is ready to be trafficked.", +"The creative has been trafficked to an adserver." +], +"readOnly": true, +"type": "string" +}, +"studioAccountId": { +"description": "Studio account ID of this creative. This field, if left unset, will be auto-populated.", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Studio advertiser ID of this studio creative. This is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCampaignId": { +"description": "Studio campaign ID of this studio creative. This is a required field on insertion.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"StudioCreativeAsset": { +"description": "Contains studio creative asset information.", +"id": "StudioCreativeAsset", +"properties": { +"createInfo": { +"$ref": "LastModifiedInfo", +"description": "Output only. The creation timestamp of the studio creative asset. This is a read-only field.", +"readOnly": true +}, +"filename": { +"description": "The filename of the studio creative asset. It is default to the original filename of the asset.", +"type": "string" +}, +"filesize": { +"description": "The filesize of the studio creative asset. This is a read-only field.", +"format": "int64", +"type": "string" +}, +"id": { +"description": "Output only. Unique ID of this studio creative asset. This is a read-only, auto-generated field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lastModifiedInfo": { +"$ref": "LastModifiedInfo", +"description": "Output only. The last modified timestamp of the studio creative asset. This is a read-only field.", +"readOnly": true +}, +"studioAccountId": { +"description": "Studio account ID of this studio creative asset. This field, if left unset, will be auto-populated..", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Studio advertiser ID of this studio creative asset. This is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCreativeId": { +"description": "Studio creative ID of this studio creative asset. The asset will be associated to the creative if creative id is set.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of the studio creative asset. It is a auto-generated, read-only field.", +"enum": [ +"UNKNOWN_TYPE", +"HTML", +"VIDEO", +"IMAGE", +"FONT" +], +"enumDescriptions": [ +"Unknown type of asset.", +"The asset is an HTML file.", +"The asset is a video file.", +"The asset is an image file.", +"The asset is a font file." +], +"type": "string" +}, +"videoProcessingData": { +"$ref": "VideoProcessingData", +"description": "The processing data of the studio creative asset. This is a read-only field." +} +}, +"type": "object" +}, +"StudioCreativeAssetsResponse": { +"description": "Response message for DfareportingStudioCreativeAssets.Insert.", +"id": "StudioCreativeAssetsResponse", +"properties": { +"assets": { +"description": "The list of studio creative assets.", +"items": { +"$ref": "StudioCreativeAsset" +}, +"type": "array" +} +}, +"type": "object" +}, +"StudioCreativeDimension": { +"description": "Dimension information for a studio creative.", +"id": "StudioCreativeDimension", +"properties": { +"height": { +"description": "Height of the studio creative.", +"format": "int32", +"type": "integer" +}, +"width": { +"description": "Width of the studio creative.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "Subaccount": { "description": "Contains properties of a Campaign Manager subaccount.", "id": "Subaccount", @@ -22624,6 +23061,34 @@ }, "type": "object" }, +"VideoProcessingData": { +"description": "Contains processing data for a video asset.", +"id": "VideoProcessingData", +"properties": { +"errorReason": { +"description": "For a FAILED processing state, the error reason discovered.", +"type": "string" +}, +"processingState": { +"description": "Output only. The processing state of the studio creative asset.", +"enum": [ +"UNKNOWN", +"PROCESSING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The processing state is unknown.", +"The asset is being processed.", +"The asset was successfully processed.", +"The asset failed to be processed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "VideoSettings": { "description": "Video Settings", "id": "VideoSettings", diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json index 544cec7326..421645c156 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json @@ -4675,11 +4675,81 @@ "scopes": [ "https://www.googleapis.com/auth/dfatrafficking" ] +}, +"retransform": { +"description": "Retransforms a dynamic feed.", +"flatPath": "studio/dynamicFeeds/{dynamicFeedsId}/retransform", +"httpMethod": "POST", +"id": "dfareporting.dynamicFeeds.retransform", +"parameterOrder": [ +"dynamicFeedId" +], +"parameters": { +"dynamicFeedId": { +"description": "Required. Dynamic feed ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicFeeds/{+dynamicFeedId}/retransform", +"response": { +"$ref": "DynamicFeed" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"update": { +"description": "Updates a new dynamic feed.", +"flatPath": "studio/dynamicFeeds", +"httpMethod": "PUT", +"id": "dfareporting.dynamicFeeds.update", +"parameterOrder": [], +"parameters": {}, +"path": "studio/dynamicFeeds", +"request": { +"$ref": "DynamicFeed" +}, +"response": { +"$ref": "DynamicFeed" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] } } }, "dynamicProfiles": { "methods": { +"generateCode": { +"description": "Generates code for a dynamic profile.", +"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/generateCode", +"httpMethod": "GET", +"id": "dfareporting.dynamicProfiles.generateCode", +"parameterOrder": [ +"dynamicProfileId" +], +"parameters": { +"dynamicProfileId": { +"description": "Required. Dynamic profile ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicProfiles/{+dynamicProfileId}/generateCode", +"response": { +"$ref": "DynamicProfileGenerateCodeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, "get": { "description": "Gets a dynamic profile by ID.", "flatPath": "studio/dynamicProfiles/{dynamicProfilesId}", @@ -4724,6 +4794,29 @@ "https://www.googleapis.com/auth/dfatrafficking" ] }, +"publish": { +"description": "Publish for a dynamic profile.", +"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/publish", +"httpMethod": "POST", +"id": "dfareporting.dynamicProfiles.publish", +"parameterOrder": [ +"dynamicProfileId" +], +"parameters": { +"dynamicProfileId": { +"description": "Required. Dynamic profile ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/dynamicProfiles/{+dynamicProfileId}/publish", +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, "update": { "description": "Updates an existing dynamic profile.", "flatPath": "studio/dynamicProfiles", @@ -8662,6 +8755,112 @@ } } }, +"studioCreativeAssets": { +"methods": { +"insert": { +"description": "Inserts a new studio creative asset.", +"flatPath": "studio/creativeAssets", +"httpMethod": "POST", +"id": "dfareporting.studioCreativeAssets.insert", +"mediaUpload": { +"accept": [ +"*/*" +], +"maxSize": "1073741824", +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/dfareporting/v5/studio/creativeAssets" +} +} +}, +"parameterOrder": [], +"parameters": {}, +"path": "studio/creativeAssets", +"request": { +"$ref": "DfareportingStudioCreativeAssetsInsertRequest" +}, +"response": { +"$ref": "StudioCreativeAssetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +], +"supportsMediaUpload": true +} +} +}, +"studioCreatives": { +"methods": { +"get": { +"description": "Gets a studio creative by ID.", +"flatPath": "studio/creatives/{creativesId}", +"httpMethod": "GET", +"id": "dfareporting.studioCreatives.get", +"parameterOrder": [ +"studioCreativeId" +], +"parameters": { +"studioCreativeId": { +"description": "Required. Studio creative ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/creatives/{+studioCreativeId}", +"response": { +"$ref": "StudioCreative" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"insert": { +"description": "Inserts a new studio creative.", +"flatPath": "studio/creatives", +"httpMethod": "POST", +"id": "dfareporting.studioCreatives.insert", +"parameterOrder": [], +"parameters": {}, +"path": "studio/creatives", +"request": { +"$ref": "StudioCreative" +}, +"response": { +"$ref": "StudioCreative" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +}, +"publish": { +"description": "Publish for a studio creative.", +"flatPath": "studio/creatives/{creativesId}/publish", +"httpMethod": "POST", +"id": "dfareporting.studioCreatives.publish", +"parameterOrder": [ +"studioCreativeId" +], +"parameters": { +"studioCreativeId": { +"description": "Required. Studio creative ID.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "studio/creatives/{+studioCreativeId}/publish", +"scopes": [ +"https://www.googleapis.com/auth/dfatrafficking" +] +} +} +}, "subaccounts": { "methods": { "get": { @@ -9806,7 +10005,7 @@ } } }, -"revision": "20250902", +"revision": "20251009", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12234,14 +12433,18 @@ "CREATIVE_AUTHORING_SOURCE_DBM", "CREATIVE_AUTHORING_SOURCE_STUDIO", "CREATIVE_AUTHORING_SOURCE_GWD", -"CREATIVE_AUTHORING_SOURCE_ACS" +"CREATIVE_AUTHORING_SOURCE_ACS", +"CREATIVE_AUTHORING_SOURCE_ADOBE", +"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", "DBM-UI used to author the creative.", "Studio-UI used to author the creative.", "Google Web Designer used to author the creative.", -"ACS-UI used to author the creative." +"ACS-UI used to author the creative.", +"Creative authoring source is Adobe.", +"Creative authoring source is Typeface.ai." ], "type": "string" }, @@ -14641,6 +14844,28 @@ }, "type": "object" }, +"DfareportingStudioCreativeAssetsInsertRequest": { +"description": "Request message for DfareportingStudioCreativeAssets.Insert.", +"id": "DfareportingStudioCreativeAssetsInsertRequest", +"properties": { +"studioAccountId": { +"description": "Optional. Studio account ID of the studio creative asset. It is a optional.", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Required. Studio advertiser ID of the studio creative asset. It is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCreativeId": { +"description": "Optional. Studio creative ID of the studio creative asset. It is a optional field. If it is set, the asset will be associated to the creative.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "DfpSettings": { "description": "Google Ad Manager Settings", "id": "DfpSettings", @@ -14992,7 +15217,7 @@ "type": "object" }, "DynamicFeedsInsertRequest": { -"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface", +"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See", "id": "DynamicFeedsInsertRequest", "properties": { "dynamicFeed": { @@ -15107,6 +15332,17 @@ }, "type": "object" }, +"DynamicProfileGenerateCodeResponse": { +"description": "Response message for DfareportingDynamicProfiles.GenerateCode.", +"id": "DynamicProfileGenerateCodeResponse", +"properties": { +"code": { +"description": "Generated code for the dynamic profile.", +"type": "string" +} +}, +"type": "object" +}, "DynamicProfileVersion": { "description": "Contains dynamic profile version information.", "id": "DynamicProfileVersion", @@ -16127,7 +16363,7 @@ "User visiting a page.", "Software download action (as for an app). A conversion type that is created as a download type may not have its category changed.", "Boom event (for user list creation). This is an internal-only category.", -"The following are conversion categories added as part of go/new-categories-prd. The addition of items to a shopping cart or bag on an advertiser site.", +". The addition of items to a shopping cart or bag on an advertiser site.", "When someone enters the checkout flow on an advertiser site.", "The start of a paid subscription for a product or service.", "The start of a free subscription for a product or service.", @@ -16140,12 +16376,12 @@ "A click to an advertiser's partner site, e.g. a referral.", "A call, SMS, email, chat or other type of contact to an advertiser.", "Key page views (ex: product page, article).", -"A website engagement event such as long site time or a GA Smart Goal, intended to be used for GA, Firebase, GA Gold goal imports. This will also be used for YouTube Hosted engagements like Add To Playlist, Likes etc. See go/add-to-playlist-conversion-buyside", +"A website engagement event", "A visit to a physical store location.", "A sale occurring in a physical store.", -"End of new conversion categories from go/new-categories-prd. A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.", +"A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.", "A lead conversion imported from an external source into Google Ads, that has further completed a desired stage as defined by the lead gen advertiser.", -"Conversion event that provides the revenue value of impressions that were shown in-app to users. See go/ad-impression-type.", +"Conversion event that provides the revenue value of impressions that were shown in-app to users.", "Message exchanges which indicate an interest in an advertiser's offering." ], "type": "string" @@ -20232,6 +20468,207 @@ }, "type": "object" }, +"StudioCreative": { +"description": "Contains studio creative information.", +"id": "StudioCreative", +"properties": { +"assetIds": { +"description": "List of assets associated with this studio creative. It is a required field on insertion.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"backupImageAssetId": { +"description": "Backup image asset ID of this studio creative.", +"format": "int64", +"type": "string" +}, +"createdInfo": { +"$ref": "LastModifiedInfo", +"description": "The timestamp when the studio creative was created. This is a read-only, auto-generated field." +}, +"dimension": { +"$ref": "StudioCreativeDimension", +"description": "Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING." +}, +"dynamicProfileId": { +"description": "Dynamic profile ID of this studio creative.", +"format": "int64", +"type": "string" +}, +"format": { +"description": "Format of this studio creative. This is a required field on insertion.", +"enum": [ +"UNKNOWN", +"BANNER", +"EXPANDING", +"INTERSTITIAL", +"VPAID_LINEAR_VIDEO" +], +"enumDescriptions": [ +"The format of the studio creative is unknown. This value is unused.", +"Banner format.", +"Expanding format.", +"Intertitial format.", +"VPAID linear video creative format." +], +"type": "string" +}, +"id": { +"description": "Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lastModifiedInfo": { +"$ref": "LastModifiedInfo", +"description": "The timestamp when the studio creative was last modified. This is a read-only, auto-generated field." +}, +"name": { +"description": "Identifier. Name of this studio creative. This is a required field on insertion.", +"type": "string" +}, +"status": { +"description": "Output only. Status of this studio creative. It is a read-only field.", +"enum": [ +"UNKNOWN_STATUS", +"IN_DEVELOPMENT", +"PUBLISHED", +"QA_REJECTED", +"QA_APPROVED", +"TRAFFICKED" +], +"enumDescriptions": [ +"The status of the studio creative is unknown. This value is unused.", +"The creative is still being developed.", +"The creative has been published and is ready for QA.", +"The creative has failed QA and must be corrected.", +"The creative has passed QA and is ready to be trafficked.", +"The creative has been trafficked to an adserver." +], +"readOnly": true, +"type": "string" +}, +"studioAccountId": { +"description": "Studio account ID of this creative. This field, if left unset, will be auto-populated.", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Studio advertiser ID of this studio creative. This is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCampaignId": { +"description": "Studio campaign ID of this studio creative. This is a required field on insertion.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"StudioCreativeAsset": { +"description": "Contains studio creative asset information.", +"id": "StudioCreativeAsset", +"properties": { +"createInfo": { +"$ref": "LastModifiedInfo", +"description": "Output only. The creation timestamp of the studio creative asset. This is a read-only field.", +"readOnly": true +}, +"filename": { +"description": "The filename of the studio creative asset. It is default to the original filename of the asset.", +"type": "string" +}, +"filesize": { +"description": "The filesize of the studio creative asset. This is a read-only field.", +"format": "int64", +"type": "string" +}, +"id": { +"description": "Output only. Unique ID of this studio creative asset. This is a read-only, auto-generated field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"lastModifiedInfo": { +"$ref": "LastModifiedInfo", +"description": "Output only. The last modified timestamp of the studio creative asset. This is a read-only field.", +"readOnly": true +}, +"studioAccountId": { +"description": "Studio account ID of this studio creative asset. This field, if left unset, will be auto-populated..", +"format": "int64", +"type": "string" +}, +"studioAdvertiserId": { +"description": "Studio advertiser ID of this studio creative asset. This is a required field on insertion.", +"format": "int64", +"type": "string" +}, +"studioCreativeId": { +"description": "Studio creative ID of this studio creative asset. The asset will be associated to the creative if creative id is set.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of the studio creative asset. It is a auto-generated, read-only field.", +"enum": [ +"UNKNOWN_TYPE", +"HTML", +"VIDEO", +"IMAGE", +"FONT" +], +"enumDescriptions": [ +"Unknown type of asset.", +"The asset is an HTML file.", +"The asset is a video file.", +"The asset is an image file.", +"The asset is a font file." +], +"type": "string" +}, +"videoProcessingData": { +"$ref": "VideoProcessingData", +"description": "The processing data of the studio creative asset. This is a read-only field." +} +}, +"type": "object" +}, +"StudioCreativeAssetsResponse": { +"description": "Response message for DfareportingStudioCreativeAssets.Insert.", +"id": "StudioCreativeAssetsResponse", +"properties": { +"assets": { +"description": "The list of studio creative assets.", +"items": { +"$ref": "StudioCreativeAsset" +}, +"type": "array" +} +}, +"type": "object" +}, +"StudioCreativeDimension": { +"description": "Dimension information for a studio creative.", +"id": "StudioCreativeDimension", +"properties": { +"height": { +"description": "Height of the studio creative.", +"format": "int32", +"type": "integer" +}, +"width": { +"description": "Width of the studio creative.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "Subaccount": { "description": "Contains properties of a Campaign Manager subaccount.", "id": "Subaccount", @@ -21495,6 +21932,34 @@ }, "type": "object" }, +"VideoProcessingData": { +"description": "Contains processing data for a video asset.", +"id": "VideoProcessingData", +"properties": { +"errorReason": { +"description": "For a FAILED processing state, the error reason discovered.", +"type": "string" +}, +"processingState": { +"description": "Output only. The processing state of the studio creative asset.", +"enum": [ +"UNKNOWN", +"PROCESSING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The processing state is unknown.", +"The asset is being processed.", +"The asset was successfully processed.", +"The asset failed to be processed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "VideoSettings": { "description": "Video Settings", "id": "VideoSettings", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 69968a41eb..ef4a0cc60f 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -9258,7 +9258,7 @@ } } }, -"revision": "20251007", +"revision": "20251013", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 434dccb7e0..a984a684c7 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8898,7 +8898,7 @@ } } }, -"revision": "20251007", +"revision": "20251013", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 4242714b86..5406e20144 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5446,7 +5446,7 @@ } } }, -"revision": "20250929", +"revision": "20251013", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -12534,6 +12534,10 @@ false "description": "The selected LLM model.", "type": "string" }, +"parameters": { +"$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettingsParameters", +"description": "Generative model parameters." +}, "promptText": { "description": "The custom prompt to use.", "type": "string" @@ -12541,6 +12545,50 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1LlmModelSettingsParameters": { +"description": "Generative model parameters to control the model behavior.", +"id": "GoogleCloudDialogflowCxV3beta1LlmModelSettingsParameters", +"properties": { +"inputTokenLimit": { +"description": "The input token limit. This setting is currently only supported by playbooks.", +"enum": [ +"INPUT_TOKEN_LIMIT_UNSPECIFIED", +"INPUT_TOKEN_LIMIT_SHORT", +"INPUT_TOKEN_LIMIT_MEDIUM", +"INPUT_TOKEN_LIMIT_LONG" +], +"enumDescriptions": [ +"Limit not specified. Treated as 'INPUT_TOKEN_LIMIT_SHORT'.", +"Input token limit up to 8k.", +"Input token limit up to 32k.", +"Input token limit up to 100k." +], +"type": "string" +}, +"outputTokenLimit": { +"description": "The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.", +"enum": [ +"OUTPUT_TOKEN_LIMIT_UNSPECIFIED", +"OUTPUT_TOKEN_LIMIT_SHORT", +"OUTPUT_TOKEN_LIMIT_MEDIUM", +"OUTPUT_TOKEN_LIMIT_LONG" +], +"enumDescriptions": [ +"Limit not specified.", +"Input token limit up to 512 tokens.", +"Input token limit up to 1k.", +"Input token limit up to 2k." +], +"type": "string" +}, +"temperature": { +"description": "The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1LoadVersionRequest": { "description": "The request message for Versions.LoadVersion.", "id": "GoogleCloudDialogflowCxV3beta1LoadVersionRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index f51c18afdb..444d559190 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -7,6 +7,12 @@ }, "https://www.googleapis.com/auth/cloud_search.query": { "description": "Search your organization's data in the Cloud Search index" +}, +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite": { +"description": "View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf." +}, +"https://www.googleapis.com/auth/discoveryengine.readwrite": { +"description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data." } } } @@ -169,7 +175,9 @@ "$ref": "GdataMedia" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ], "supportsMediaDownload": true, "useMediaDownloadService": true @@ -203,7 +211,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -232,7 +241,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getCmekConfig": { @@ -257,7 +267,8 @@ "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setUpDataConnector": { @@ -285,7 +296,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setUpDataConnectorV2": { @@ -323,7 +336,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateAclConfig": { @@ -351,7 +366,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateCmekConfig": { @@ -384,7 +400,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -413,7 +430,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -438,7 +456,8 @@ "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -463,7 +482,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -496,7 +516,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -525,7 +546,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getDataConnector": { @@ -550,7 +572,9 @@ "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateDataConnector": { @@ -584,7 +608,9 @@ "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -615,7 +641,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -661,7 +688,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -712,7 +740,9 @@ "$ref": "GoogleCloudDiscoveryengineV1CompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -765,7 +795,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -790,7 +821,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -815,7 +847,8 @@ "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -840,7 +873,8 @@ "$ref": "GoogleCloudDiscoveryengineV1SiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -881,7 +915,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -915,7 +950,8 @@ "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "trainCustomModel": { @@ -943,7 +979,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -984,7 +1021,8 @@ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -1021,7 +1059,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1046,7 +1085,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1071,7 +1111,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -1099,7 +1140,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1135,7 +1177,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1174,7 +1217,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -1202,7 +1246,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1234,7 +1279,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1259,7 +1305,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1305,7 +1352,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1340,7 +1388,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1372,7 +1422,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -1400,7 +1452,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1437,7 +1491,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1462,7 +1517,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1487,7 +1543,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1528,7 +1585,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1562,7 +1620,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1594,7 +1653,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -1622,7 +1682,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1647,7 +1708,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1672,7 +1734,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1718,7 +1781,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1752,7 +1816,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1781,7 +1846,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1812,7 +1878,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1858,7 +1925,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1889,7 +1957,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1935,7 +2004,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1972,7 +2042,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1997,7 +2068,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2022,7 +2094,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2058,7 +2131,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2091,7 +2165,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2120,7 +2195,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2166,7 +2242,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2200,7 +2277,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2234,7 +2312,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -2262,7 +2341,8 @@ "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -2290,7 +2370,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -2318,7 +2400,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -2346,7 +2430,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2378,7 +2463,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2403,7 +2490,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2433,7 +2522,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2479,7 +2570,9 @@ "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2513,7 +2606,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2542,7 +2637,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2576,7 +2672,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "disableAdvancedSiteSearch": { @@ -2604,7 +2701,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -2632,7 +2730,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetchDomainVerificationStatus": { @@ -2668,7 +2767,8 @@ "$ref": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -2696,7 +2796,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2725,7 +2826,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2771,7 +2873,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2803,7 +2906,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2828,7 +2932,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -2859,7 +2964,8 @@ "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2891,7 +2997,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -2919,7 +3026,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2944,7 +3052,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2969,7 +3078,8 @@ "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3005,7 +3115,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3033,7 +3144,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3062,7 +3174,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3108,7 +3221,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3144,7 +3258,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -3172,7 +3288,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3217,7 +3335,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -3245,7 +3365,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -3273,7 +3395,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -3306,7 +3430,9 @@ "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3345,7 +3471,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3370,7 +3497,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3395,7 +3523,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3436,7 +3565,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListEnginesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3470,7 +3600,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3499,7 +3630,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3533,7 +3666,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAssist": { @@ -3561,7 +3696,9 @@ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3594,7 +3731,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3631,7 +3770,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3656,7 +3796,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3681,7 +3822,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3722,7 +3864,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3756,7 +3899,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3788,7 +3932,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -3816,7 +3961,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3841,7 +3987,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3866,7 +4013,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3912,7 +4060,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3946,7 +4095,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3978,7 +4128,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4003,7 +4154,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4049,7 +4201,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4081,7 +4234,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4115,7 +4269,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -4143,7 +4298,8 @@ "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -4171,7 +4327,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -4199,7 +4357,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -4227,7 +4387,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4259,7 +4420,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4284,7 +4447,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4314,7 +4479,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4360,7 +4527,9 @@ "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4394,7 +4563,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4423,7 +4594,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4456,7 +4628,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4502,7 +4675,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4553,7 +4727,9 @@ "$ref": "GoogleCloudDiscoveryengineV1CompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -4606,7 +4782,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4631,7 +4808,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4656,7 +4834,8 @@ "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -4681,7 +4860,8 @@ "$ref": "GoogleCloudDiscoveryengineV1SiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4722,7 +4902,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4756,7 +4937,8 @@ "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4797,7 +4979,8 @@ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4834,7 +5017,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4859,7 +5043,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4884,7 +5069,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -4912,7 +5098,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4948,7 +5135,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4987,7 +5175,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Document" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -5015,7 +5204,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5047,7 +5237,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5072,7 +5263,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5118,7 +5310,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5153,7 +5346,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5185,7 +5380,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -5213,7 +5410,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5250,7 +5449,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5275,7 +5475,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5300,7 +5501,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5341,7 +5543,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5375,7 +5578,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5407,7 +5611,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -5435,7 +5640,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5460,7 +5666,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5485,7 +5692,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5531,7 +5739,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5565,7 +5774,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5596,7 +5806,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5642,7 +5853,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5673,7 +5885,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5719,7 +5932,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5756,7 +5970,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5781,7 +5996,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5806,7 +6022,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5842,7 +6059,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5875,7 +6093,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5907,7 +6126,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5941,7 +6161,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -5969,7 +6190,8 @@ "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -5997,7 +6219,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -6025,7 +6249,9 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -6053,7 +6279,8 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6085,7 +6312,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6110,7 +6339,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6140,7 +6371,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6186,7 +6419,9 @@ "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6220,7 +6455,9 @@ "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6249,7 +6486,8 @@ "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6283,7 +6521,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -6311,7 +6550,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -6339,7 +6579,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6371,7 +6612,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6396,7 +6638,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -6427,7 +6670,8 @@ "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6459,7 +6703,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -6487,7 +6732,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6512,7 +6758,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6537,7 +6784,8 @@ "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6573,7 +6821,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6601,7 +6850,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6635,7 +6885,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6663,7 +6915,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6708,7 +6962,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -6736,7 +6992,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6764,7 +7022,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -6797,7 +7057,9 @@ "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6831,7 +7093,8 @@ "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6878,7 +7141,8 @@ "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6903,7 +7167,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6928,7 +7193,8 @@ "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "importIdentityMappings": { @@ -6956,7 +7222,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6992,7 +7259,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listIdentityMappings": { @@ -7028,7 +7296,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purgeIdentityMappings": { @@ -7056,7 +7325,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7085,7 +7355,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7131,7 +7402,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7170,7 +7442,8 @@ "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7195,7 +7468,8 @@ "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7229,7 +7503,8 @@ "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7258,7 +7533,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7304,7 +7580,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7335,7 +7612,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7369,7 +7647,8 @@ "$ref": "GoogleCloudDiscoveryengineV1RankResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7414,7 +7693,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -7442,7 +7723,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -7475,7 +7758,9 @@ "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7507,7 +7792,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7552,7 +7838,8 @@ "$ref": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7588,7 +7875,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7613,7 +7901,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7659,7 +7948,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7667,7 +7957,7 @@ } } }, -"revision": "20250929", +"revision": "20251017", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8930,67 +9220,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1AlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", @@ -10627,6 +10856,10 @@ "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent", "properties": { +"citationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1CitationMetadata", +"description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1AssistantContent", "description": "The content." @@ -11490,6 +11723,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1Citation": { +"description": "Source attributions for content.", +"id": "GoogleCloudDiscoveryengineV1Citation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "GoogleTypeDate", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "GoogleCloudDiscoveryengineV1CitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Citation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1CloudSqlSource", @@ -11776,17 +12063,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1ContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -14705,10 +14981,6 @@ "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1LicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -14721,6 +14993,11 @@ "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -17219,6 +17496,13 @@ false "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, +"labels": { +"description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", +"items": { +"type": "string" +}, +"type": "array" +}, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" @@ -17522,7 +17806,7 @@ false }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", -"description": "Session information." +"description": "Session information. Only included in the final StreamAssistResponse of the response stream." } }, "type": "object" @@ -19162,6 +19446,10 @@ false "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "properties": { +"citationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", "description": "The content." @@ -19386,6 +19674,60 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCitation": { +"description": "Source attributions for content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "GoogleTypeDate", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", @@ -22384,6 +22726,11 @@ false "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -24129,6 +24476,13 @@ false "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, +"labels": { +"description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", +"items": { +"type": "string" +}, +"type": "array" +}, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" @@ -24759,67 +25113,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -25040,17 +25333,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1betaContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -26710,10 +26992,6 @@ false "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -26726,6 +27004,11 @@ false "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 31bc64c459..1059b71aa8 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -7,6 +7,12 @@ }, "https://www.googleapis.com/auth/cloud_search.query": { "description": "Search your organization's data in the Cloud Search index" +}, +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite": { +"description": "View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf." +}, +"https://www.googleapis.com/auth/discoveryengine.readwrite": { +"description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data." } } } @@ -169,7 +175,9 @@ "$ref": "GdataMedia" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ], "supportsMediaDownload": true, "useMediaDownloadService": true @@ -200,7 +208,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -234,7 +243,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "provision": { @@ -262,7 +272,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "reportConsentChange": { @@ -290,7 +301,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -322,7 +334,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getAclConfig": { @@ -347,7 +360,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getCmekConfig": { @@ -372,7 +386,92 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"getConfigurablePricingUsageStats": { +"description": "Gets configurable pricing usage stats.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/configurablePricingUsageStats", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.getConfigurablePricingUsageStats", +"parameterOrder": [ +"name" +], +"parameters": { +"metricTypes": { +"description": "Optional. The metric types to return usage for.", +"enum": [ +"BILLING_METRIC_TYPE_UNSPECIFIED", +"DAILY_MDN_QPM", +"DAILY_MIN_QPM", +"DAILY_MAX_QPM", +"DAILY_SEARCH_REQUEST", +"TOTAL_STORAGE" +], +"enumDescriptions": [ +"Default value.", +"Daily median search request QPM.", +"Daily min search request QPM.", +"Daily max search request QPM.", +"Daily search request total.", +"Total storage bytes for indexing core." +], +"location": "query", +"repeated": true, +"type": "string" +}, +"name": { +"description": "Required. The name of the ConfigurablePricingUsageStats to retrieve. Format: projects/{project}/locations/{location}/configurablePricingUsageStats", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/configurablePricingUsageStats$", +"required": true, +"type": "string" +}, +"timeRange.endDate.day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"timeRange.endDate.month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"timeRange.endDate.year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"timeRange.startDate.day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"timeRange.startDate.month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"timeRange.startDate.year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"location": "query", +"type": "integer" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "obtainCrawlRate": { @@ -400,7 +499,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "removeDedicatedCrawlRate": { @@ -428,7 +528,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setDedicatedCrawlRate": { @@ -456,7 +557,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setUpDataConnector": { @@ -484,7 +586,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setUpDataConnectorV2": { @@ -522,7 +626,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateAclConfig": { @@ -550,7 +656,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateCmekConfig": { @@ -583,7 +690,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -612,7 +720,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -637,7 +746,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -662,7 +772,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -695,7 +806,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -724,7 +836,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -749,7 +862,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getDataConnector": { @@ -774,7 +888,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -815,7 +931,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -849,7 +966,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateDataConnector": { @@ -883,7 +1001,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -915,7 +1035,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "checkRefreshToken": { @@ -941,7 +1063,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getConnectorSecret": { @@ -966,7 +1090,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "startConnectorRun": { @@ -994,7 +1120,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -1034,7 +1162,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1063,7 +1193,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1109,7 +1240,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1160,7 +1292,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -1213,7 +1347,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1238,7 +1373,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1263,7 +1399,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getDocumentProcessingConfig": { @@ -1288,7 +1425,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -1313,7 +1451,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1354,7 +1493,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1388,7 +1528,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "trainCustomModel": { @@ -1416,7 +1557,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateDocumentProcessingConfig": { @@ -1450,7 +1592,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -1491,7 +1634,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1531,7 +1675,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1571,7 +1716,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -1608,7 +1754,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1633,7 +1780,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1658,7 +1806,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getProcessedDocument": { @@ -1720,7 +1869,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -1748,7 +1898,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1784,7 +1935,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1823,7 +1975,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -1851,7 +2004,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -1880,7 +2034,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1916,7 +2071,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1950,7 +2106,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1975,7 +2132,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2021,7 +2179,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2056,7 +2215,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2088,7 +2249,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -2116,7 +2279,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2153,7 +2318,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2178,7 +2344,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2203,7 +2370,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2244,7 +2412,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2278,7 +2447,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2310,7 +2480,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -2338,7 +2509,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2363,7 +2535,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2388,7 +2561,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2434,7 +2608,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2468,7 +2643,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2497,7 +2673,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2528,7 +2705,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2574,7 +2752,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2605,7 +2784,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2651,7 +2831,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2688,7 +2869,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2713,7 +2895,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2738,7 +2921,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2774,7 +2958,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2807,7 +2992,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2836,7 +3022,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2882,7 +3069,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2916,7 +3104,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2941,7 +3130,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2977,7 +3167,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3011,7 +3202,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -3039,7 +3231,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -3067,7 +3260,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -3095,7 +3290,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -3123,7 +3320,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3155,7 +3353,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3180,7 +3380,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3210,7 +3412,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3256,7 +3460,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3290,7 +3496,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3319,7 +3527,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3353,7 +3562,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "disableAdvancedSiteSearch": { @@ -3381,7 +3591,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -3409,7 +3620,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetchDomainVerificationStatus": { @@ -3445,7 +3657,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getUriPatternDocumentData": { @@ -3470,7 +3683,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -3498,7 +3712,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setUriPatternDocumentData": { @@ -3526,7 +3741,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3555,7 +3771,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3601,7 +3818,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3633,7 +3851,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3658,7 +3877,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -3689,7 +3909,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3721,7 +3942,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -3749,7 +3971,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3774,7 +3997,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3799,7 +4023,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3835,7 +4060,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3863,7 +4089,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3892,7 +4119,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3938,7 +4166,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3974,7 +4203,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -4002,7 +4233,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4047,7 +4280,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -4075,7 +4310,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -4103,7 +4340,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -4136,7 +4375,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4175,7 +4416,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4214,7 +4457,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4239,7 +4483,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4264,7 +4509,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getWorkspaceSettings": { @@ -4289,7 +4535,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4330,7 +4577,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4364,7 +4612,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "pause": { @@ -4392,7 +4641,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "resume": { @@ -4420,7 +4670,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "tune": { @@ -4448,7 +4699,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4480,7 +4732,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4509,7 +4762,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4543,7 +4798,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAssist": { @@ -4571,7 +4828,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4604,7 +4863,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "removeSuggestion": { @@ -4632,7 +4893,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4669,7 +4932,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4694,7 +4958,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4719,7 +4984,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4760,7 +5026,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4794,7 +5061,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4826,7 +5094,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -4854,7 +5123,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4879,7 +5149,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4904,7 +5175,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4950,7 +5222,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4984,7 +5257,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5013,7 +5287,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5059,7 +5334,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5091,7 +5367,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5116,7 +5393,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5152,7 +5430,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5186,7 +5465,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -5214,7 +5494,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -5242,7 +5523,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -5270,7 +5553,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -5298,7 +5583,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5330,7 +5616,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5355,7 +5643,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5385,7 +5675,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5431,7 +5723,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5465,7 +5759,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -5494,7 +5790,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5544,7 +5841,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListFilesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5585,7 +5884,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5616,7 +5917,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5662,7 +5964,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5713,7 +6016,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -5766,7 +6071,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5791,7 +6097,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5816,7 +6123,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getDocumentProcessingConfig": { @@ -5841,7 +6149,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -5866,7 +6175,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5907,7 +6217,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5941,7 +6252,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateDocumentProcessingConfig": { @@ -5975,7 +6287,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6016,7 +6329,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6056,7 +6370,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6096,7 +6411,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6133,7 +6449,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6158,7 +6475,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6183,7 +6501,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getProcessedDocument": { @@ -6245,7 +6564,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -6273,7 +6593,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6309,7 +6630,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6348,7 +6670,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6376,7 +6699,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6405,7 +6729,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6441,7 +6766,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6475,7 +6801,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6500,7 +6827,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6546,7 +6874,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6581,7 +6910,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6613,7 +6944,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6641,7 +6974,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6678,7 +7013,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6703,7 +7039,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6728,7 +7065,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6769,7 +7107,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6803,7 +7142,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6835,7 +7175,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -6863,7 +7204,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6888,7 +7230,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6913,7 +7256,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6959,7 +7303,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6993,7 +7338,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7024,7 +7370,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7070,7 +7417,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7101,7 +7449,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7147,7 +7496,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7184,7 +7534,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7209,7 +7560,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7234,7 +7586,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7270,7 +7623,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7303,7 +7657,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7335,7 +7690,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7360,7 +7716,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7396,7 +7753,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7430,7 +7788,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -7458,7 +7817,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -7486,7 +7846,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -7514,7 +7876,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -7542,7 +7906,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7574,7 +7939,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7599,7 +7966,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7629,7 +7998,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7675,7 +8046,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7709,7 +8082,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7738,7 +8113,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7772,7 +8148,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -7800,7 +8177,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -7828,7 +8206,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7860,7 +8239,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7885,7 +8265,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -7916,7 +8297,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7948,7 +8330,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -7976,7 +8359,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -8001,7 +8385,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -8026,7 +8411,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8062,7 +8448,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -8090,7 +8477,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8124,7 +8512,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -8152,7 +8542,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8197,7 +8589,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -8225,7 +8619,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -8253,7 +8649,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -8286,7 +8684,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8325,7 +8725,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8359,7 +8761,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -8384,7 +8787,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8420,7 +8824,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listResults": { @@ -8456,7 +8861,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -8485,7 +8891,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8519,7 +8926,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8566,7 +8974,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -8591,7 +9000,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -8616,7 +9026,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "importIdentityMappings": { @@ -8644,7 +9055,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8680,7 +9092,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listIdentityMappings": { @@ -8716,7 +9129,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purgeIdentityMappings": { @@ -8744,7 +9158,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -8773,7 +9188,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8819,7 +9235,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8858,7 +9275,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -8883,7 +9301,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -8917,7 +9336,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8949,7 +9369,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -8977,7 +9398,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaNotebook" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -9002,7 +9424,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaNotebook" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listRecentlyViewed": { @@ -9038,7 +9461,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "share": { @@ -9066,7 +9490,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaShareNotebookResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -9098,7 +9523,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -9123,7 +9549,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9155,7 +9582,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "batchDelete": { @@ -9183,7 +9611,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -9208,7 +9637,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaSource" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "uploadFile": { @@ -9243,7 +9673,8 @@ "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9274,7 +9705,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -9320,7 +9752,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9351,7 +9784,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9385,7 +9819,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaRankResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9417,7 +9852,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9454,7 +9890,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -9479,7 +9916,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -9504,7 +9942,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -9540,7 +9979,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -9574,7 +10014,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -9603,7 +10044,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9640,7 +10082,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -9665,7 +10108,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -9690,7 +10134,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -9718,7 +10163,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -9754,7 +10200,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -9788,7 +10235,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9835,7 +10283,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -9863,7 +10313,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -9896,7 +10348,9 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -9928,7 +10382,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -9957,7 +10412,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -10003,7 +10459,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -10048,7 +10505,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -10081,7 +10539,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -10127,7 +10586,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -10135,7 +10595,7 @@ } } }, -"revision": "20251008", +"revision": "20251017", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -11253,67 +11713,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", @@ -11815,17 +12214,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1ContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -13825,10 +14213,6 @@ "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1LicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -13841,6 +14225,11 @@ "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -17211,6 +17600,10 @@ "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "properties": { +"citationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", "description": "The content." @@ -18224,6 +18617,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCitation": { +"description": "Source attributions for content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "GoogleTypeDate", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", @@ -18515,6 +18962,82 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats": { +"description": "Response for [EstimateBillingService.GetConfigurablePricingUsageStats] method.", +"id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats", +"properties": { +"metricUsages": { +"description": "A list of metric usages, one for each requested resource type that has data in the requested time range.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The name of the ConfigurablePricingUsageStats. Format: projects/{project}/locations/{location}/configurablePricingUsageStats", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage": { +"description": "A list of usages for a specific day.", +"id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage", +"properties": { +"date": { +"$ref": "GoogleTypeDate", +"description": "The date of the usage." +}, +"usage": { +"description": "The usage value on the date.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage": { +"description": "The usage of a metric over a list of days.", +"id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage", +"properties": { +"datedUsages": { +"description": "The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage" +}, +"type": "array" +}, +"metricType": { +"description": "The metric type.", +"enum": [ +"BILLING_METRIC_TYPE_UNSPECIFIED", +"DAILY_MDN_QPM", +"DAILY_MIN_QPM", +"DAILY_MAX_QPM", +"DAILY_SEARCH_REQUEST", +"TOTAL_STORAGE" +], +"enumDescriptions": [ +"Default value.", +"Daily median search request QPM.", +"Daily min search request QPM.", +"Daily max search request QPM.", +"Daily search request total.", +"Total storage bytes for indexing core." +], +"type": "string" +}, +"totalUsages": { +"description": "The list of total usages for this resource type", +"items": { +"format": "double", +"type": "number" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaConnectorRun": { "description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //", "id": "GoogleCloudDiscoveryengineV1alphaConnectorRun", @@ -22632,6 +23155,11 @@ "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -26608,6 +27136,13 @@ false "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, +"labels": { +"description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", +"items": { +"type": "string" +}, +"type": "array" +}, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" @@ -27085,7 +27620,7 @@ false }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", -"description": "Session information." +"description": "Session information. Only included in the final StreamAssistResponse of the response stream." } }, "type": "object" @@ -28626,67 +29161,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -28907,17 +29381,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1betaContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -30577,10 +31040,6 @@ false "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -30593,6 +31052,11 @@ false "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index b727e38cb7..b6fdbe166b 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -7,6 +7,12 @@ }, "https://www.googleapis.com/auth/cloud_search.query": { "description": "Search your organization's data in the Cloud Search index" +}, +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite": { +"description": "View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf." +}, +"https://www.googleapis.com/auth/discoveryengine.readwrite": { +"description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data." } } } @@ -169,7 +175,9 @@ "$ref": "GdataMedia" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ], "supportsMediaDownload": true, "useMediaDownloadService": true @@ -203,7 +211,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -232,7 +241,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getCmekConfig": { @@ -257,7 +267,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "obtainCrawlRate": { @@ -285,7 +296,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "removeDedicatedCrawlRate": { @@ -313,7 +325,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "setDedicatedCrawlRate": { @@ -341,7 +354,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateAclConfig": { @@ -369,7 +383,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAclConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "updateCmekConfig": { @@ -402,7 +417,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -431,7 +447,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -456,7 +473,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -481,7 +499,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -514,7 +533,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -547,7 +567,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -593,7 +614,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -644,7 +666,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -697,7 +721,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -722,7 +747,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -747,7 +773,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -772,7 +799,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -813,7 +841,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -847,7 +876,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "trainCustomModel": { @@ -875,7 +905,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -916,7 +947,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -953,7 +985,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -978,7 +1011,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1003,7 +1037,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -1031,7 +1066,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1067,7 +1103,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1106,7 +1143,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -1134,7 +1172,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1166,7 +1205,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1191,7 +1231,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1237,7 +1278,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1272,7 +1314,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1304,7 +1348,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -1332,7 +1378,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1369,7 +1417,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1394,7 +1443,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1419,7 +1469,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1460,7 +1511,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1494,7 +1546,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1526,7 +1579,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -1554,7 +1608,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1579,7 +1634,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1604,7 +1660,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1650,7 +1707,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -1684,7 +1742,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1713,7 +1772,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1744,7 +1804,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1790,7 +1851,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1821,7 +1883,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1867,7 +1930,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -1904,7 +1968,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -1929,7 +1994,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -1954,7 +2020,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSchema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -1990,7 +2057,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2023,7 +2091,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2052,7 +2121,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2098,7 +2168,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2132,7 +2203,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2157,7 +2229,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2193,7 +2266,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2227,7 +2301,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -2255,7 +2330,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -2283,7 +2359,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -2311,7 +2389,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -2339,7 +2419,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2371,7 +2452,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2396,7 +2479,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2426,7 +2511,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2472,7 +2559,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -2506,7 +2595,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2535,7 +2626,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2569,7 +2661,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "disableAdvancedSiteSearch": { @@ -2597,7 +2690,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -2625,7 +2719,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetchDomainVerificationStatus": { @@ -2661,7 +2756,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -2689,7 +2785,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -2718,7 +2815,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2764,7 +2862,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2796,7 +2895,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2821,7 +2921,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -2852,7 +2953,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -2884,7 +2986,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -2912,7 +3015,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -2937,7 +3041,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -2962,7 +3067,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -2998,7 +3104,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3026,7 +3133,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3055,7 +3163,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3101,7 +3210,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3137,7 +3247,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -3165,7 +3277,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3210,7 +3324,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -3238,7 +3354,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -3266,7 +3384,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -3299,7 +3419,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3338,7 +3460,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3363,7 +3486,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3388,7 +3512,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3429,7 +3554,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListEnginesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3463,7 +3589,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "pause": { @@ -3491,7 +3618,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "resume": { @@ -3519,7 +3647,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "tune": { @@ -3547,7 +3676,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -3576,7 +3706,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAssistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3610,7 +3742,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAssistant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAssist": { @@ -3638,7 +3772,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3671,7 +3807,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "removeSuggestion": { @@ -3699,7 +3837,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3736,7 +3876,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3761,7 +3902,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3786,7 +3928,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -3827,7 +3970,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -3861,7 +4005,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -3893,7 +4038,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -3921,7 +4067,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -3946,7 +4093,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -3971,7 +4119,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4017,7 +4166,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4051,7 +4201,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4080,7 +4231,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4126,7 +4278,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4158,7 +4311,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4183,7 +4337,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4219,7 +4374,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4253,7 +4409,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -4281,7 +4438,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -4309,7 +4467,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -4337,7 +4497,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -4365,7 +4527,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4397,7 +4560,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4422,7 +4587,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4452,7 +4619,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4498,7 +4667,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4532,7 +4703,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4561,7 +4734,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4594,7 +4768,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4640,7 +4815,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -4691,7 +4867,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -4744,7 +4922,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4769,7 +4948,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -4794,7 +4974,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "getSiteSearchEngine": { @@ -4819,7 +5000,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -4860,7 +5042,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -4894,7 +5077,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDataStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4935,7 +5119,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -4972,7 +5157,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -4997,7 +5183,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5022,7 +5209,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -5050,7 +5238,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5086,7 +5275,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5125,7 +5315,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocument" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -5153,7 +5344,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5185,7 +5377,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5210,7 +5403,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5256,7 +5450,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5291,7 +5486,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud_search.query" +"https://www.googleapis.com/auth/cloud_search.query", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5323,7 +5520,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -5351,7 +5550,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5388,7 +5589,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5413,7 +5615,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5438,7 +5641,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5479,7 +5683,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5513,7 +5718,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaControl" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5545,7 +5751,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -5573,7 +5780,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5598,7 +5806,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5623,7 +5832,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5669,7 +5879,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -5703,7 +5914,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5734,7 +5946,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5780,7 +5993,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5811,7 +6025,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5857,7 +6072,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -5894,7 +6110,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -5919,7 +6136,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -5944,7 +6162,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSchema" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -5980,7 +6199,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6013,7 +6233,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6045,7 +6266,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6070,7 +6292,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6106,7 +6329,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6140,7 +6364,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recommend": { @@ -6168,7 +6393,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "search": { @@ -6196,7 +6422,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "searchLite": { @@ -6224,7 +6452,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "streamAnswer": { @@ -6252,7 +6482,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6284,7 +6515,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6309,7 +6542,9 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6339,7 +6574,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6385,7 +6622,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6419,7 +6658,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6448,7 +6689,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswer" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6482,7 +6724,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "enableAdvancedSiteSearch": { @@ -6510,7 +6753,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "recrawlUris": { @@ -6538,7 +6782,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -6570,7 +6815,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6595,7 +6841,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "fetch": { @@ -6626,7 +6873,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6658,7 +6906,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "create": { @@ -6686,7 +6935,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -6711,7 +6961,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -6736,7 +6987,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -6772,7 +7024,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -6800,7 +7053,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6834,7 +7088,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6862,7 +7118,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -6907,7 +7165,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -6935,7 +7195,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purge": { @@ -6963,7 +7225,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -6996,7 +7260,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7030,7 +7296,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7055,7 +7322,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7091,7 +7359,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listResults": { @@ -7127,7 +7396,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7156,7 +7426,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7190,7 +7461,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7237,7 +7509,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7262,7 +7535,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7287,7 +7561,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "importIdentityMappings": { @@ -7315,7 +7590,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7351,7 +7627,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "listIdentityMappings": { @@ -7387,7 +7664,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "purgeIdentityMappings": { @@ -7415,7 +7693,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7444,7 +7723,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7490,7 +7770,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7529,7 +7810,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7554,7 +7836,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7588,7 +7871,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7617,7 +7901,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7663,7 +7948,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7694,7 +7980,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7728,7 +8015,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaRankResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7765,7 +8053,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7790,7 +8079,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -7815,7 +8105,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -7851,7 +8142,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -7885,7 +8177,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -7914,7 +8207,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -7951,7 +8245,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "delete": { @@ -7976,7 +8271,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "get": { @@ -8001,7 +8297,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -8029,7 +8326,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8065,7 +8363,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "patch": { @@ -8099,7 +8398,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8146,7 +8446,9 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "import": { @@ -8174,7 +8476,9 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "write": { @@ -8207,7 +8511,9 @@ "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8239,7 +8545,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } }, @@ -8284,7 +8591,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaListUserLicensesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8317,7 +8625,8 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, "list": { @@ -8363,7 +8672,8 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" ] } } @@ -8371,7 +8681,7 @@ } } }, -"revision": "20250929", +"revision": "20251017", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -9322,67 +9632,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", @@ -9884,17 +10133,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1ContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -11894,10 +12132,6 @@ "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1LicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -11910,6 +12144,11 @@ "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -14078,6 +14317,10 @@ "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "properties": { +"citationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", "description": "The content." @@ -14302,6 +14545,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCitation": { +"description": "Source attributions for content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "GoogleTypeDate", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCitation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", @@ -17300,6 +17597,11 @@ "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -19045,6 +19347,13 @@ false "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, +"labels": { +"description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", +"items": { +"type": "string" +}, +"type": "array" +}, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" @@ -19987,67 +20296,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", -"type": "string" -}, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" -}, -"type": "array" -}, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", -"properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" -}, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], -"type": "string" -}, -"notificationParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -21785,6 +22033,10 @@ false "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", "id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContent", "properties": { +"citationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaCitationMetadata", +"description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1betaAssistantContent", "description": "The content." @@ -22615,6 +22867,60 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCitation": { +"description": "Source attributions for content.", +"id": "GoogleCloudDiscoveryengineV1betaCitation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "GoogleTypeDate", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "GoogleCloudDiscoveryengineV1betaCitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaCitation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1betaCloudSqlSource", @@ -22880,17 +23186,6 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaContactDetails": { -"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", -"id": "GoogleCloudDiscoveryengineV1betaContactDetails", -"properties": { -"emailAddress": { -"description": "Optional. The email address of the contact.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -25497,10 +25792,6 @@ false "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", "properties": { -"alertPolicyResourceConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", -"description": "Optional. The alert policy config for this license config." -}, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" @@ -25513,6 +25804,11 @@ false "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, +"geminiBundle": { +"description": "Output only. Whether the license config is for Gemini bundle.", +"readOnly": true, +"type": "boolean" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -28934,6 +29230,13 @@ false "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, +"labels": { +"description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", +"items": { +"type": "string" +}, +"type": "array" +}, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" @@ -29299,7 +29602,7 @@ false }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", -"description": "Session information." +"description": "Session information. Only included in the final StreamAssistResponse of the response stream." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 0ce6b0b40c..cc1d73cb22 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -783,7 +783,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -911,7 +911,7 @@ ], "parameters": { "filter": { -"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR", +"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.", "location": "query", "type": "string" }, @@ -980,7 +980,7 @@ ], "parameters": { "filter": { -"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR", +"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.", "location": "query", "type": "string" }, @@ -1332,7 +1332,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -1452,7 +1452,7 @@ ], "parameters": { "filter": { -"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -1780,7 +1780,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -1903,7 +1903,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -2159,7 +2159,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -2721,7 +2721,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -3085,7 +3085,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -3210,7 +3210,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -3338,7 +3338,7 @@ ], "parameters": { "filter": { -"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR", +"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.", "location": "query", "type": "string" }, @@ -3407,7 +3407,7 @@ ], "parameters": { "filter": { -"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR", +"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.", "location": "query", "type": "string" }, @@ -4009,7 +4009,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4129,7 +4129,7 @@ ], "parameters": { "filter": { -"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4545,7 +4545,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4668,7 +4668,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4924,7 +4924,7 @@ ], "parameters": { "filter": { -"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", +"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -5123,7 +5123,7 @@ } } }, -"revision": "20251004", +"revision": "20251012", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 52056c2506..b6f4419cb8 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20250925", +"revision": "20251013", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -922,6 +922,27 @@ }, "type": "object" }, +"DocumentFormat": { +"description": "Represents document-level format settings.", +"id": "DocumentFormat", +"properties": { +"documentMode": { +"description": "Whether the document has pages or is pageless.", +"enum": [ +"DOCUMENT_MODE_UNSPECIFIED", +"PAGES", +"PAGELESS" +], +"enumDescriptions": [ +"The document mode is unspecified.", +"The document has pages.", +"The document is pageless." +], +"type": "string" +} +}, +"type": "object" +}, "DocumentStyle": { "description": "The style of the document.", "id": "DocumentStyle", @@ -938,6 +959,10 @@ "description": "The ID of the default header. If not set, there's no default header. This property is read-only.", "type": "string" }, +"documentFormat": { +"$ref": "DocumentFormat", +"description": "Specifies document-level format settings, such as the document mode (pages vs pageless)." +}, "evenPageFooterId": { "description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.", "type": "string" @@ -3762,6 +3787,10 @@ "description": "Properties of a tab.", "id": "TabProperties", "properties": { +"iconEmoji": { +"description": "Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon.", +"type": "string" +}, "index": { "description": "The zero-based index of the tab within the parent.", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index b841dcab82..f3baa14782 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1053,7 +1053,7 @@ } } }, -"revision": "20251007", +"revision": "20251013", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -2984,6 +2984,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "signatureValue": { +"description": "A signature - a graphical representation of a person's name, often used to sign a document.", "type": "boolean" }, "text": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 8da4c21986..66c5cca6f9 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1295,7 +1295,7 @@ } } }, -"revision": "20251007", +"revision": "20251013", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -4006,6 +4006,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "signatureValue": { +"description": "A signature - a graphical representation of a person's name, often used to sign a document.", "type": "boolean" }, "text": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 272ff6abdb..9da421777c 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1850,7 +1850,7 @@ "permissions": { "methods": { "create": { -"description": "Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", +"description": "Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "flatPath": "files/{fileId}/permissions", "httpMethod": "POST", "id": "drive.permissions.create", @@ -1884,7 +1884,7 @@ }, "moveToNewOwnersRoot": { "default": "false", -"description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.", +"description": "This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.", "location": "query", "type": "boolean" }, @@ -1908,13 +1908,13 @@ }, "transferOwnership": { "default": "false", -"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", +"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).", "location": "query", "type": "boolean" }, "useDomainAdminAccess": { "default": "false", -"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", +"description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "location": "query", "type": "boolean" } @@ -1932,7 +1932,7 @@ ] }, "delete": { -"description": "Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", +"description": "Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "id": "drive.permissions.delete", @@ -1974,7 +1974,7 @@ }, "useDomainAdminAccess": { "default": "false", -"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", +"description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "location": "query", "type": "boolean" } @@ -1986,7 +1986,7 @@ ] }, "get": { -"description": "Gets a permission by ID.", +"description": "Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).", "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "GET", "id": "drive.permissions.get", @@ -2022,7 +2022,7 @@ }, "useDomainAdminAccess": { "default": "false", -"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", +"description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "location": "query", "type": "boolean" } @@ -2042,7 +2042,7 @@ ] }, "list": { -"description": "Lists a file's or shared drive's permissions.", +"description": "Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).", "flatPath": "files/{fileId}/permissions", "httpMethod": "GET", "id": "drive.permissions.list", @@ -2057,7 +2057,7 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -2070,7 +2070,7 @@ "type": "integer" }, "pageToken": { -"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", +"description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" }, @@ -2089,7 +2089,7 @@ }, "useDomainAdminAccess": { "default": "false", -"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", +"description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "location": "query", "type": "boolean" } @@ -2109,7 +2109,7 @@ ] }, "update": { -"description": "Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", +"description": "Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "PATCH", "id": "drive.permissions.update", @@ -2157,13 +2157,13 @@ }, "transferOwnership": { "default": "false", -"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", +"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file).", "location": "query", "type": "boolean" }, "useDomainAdminAccess": { "default": "false", -"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", +"description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "location": "query", "type": "boolean" } @@ -2720,7 +2720,7 @@ } } }, -"revision": "20250910", +"revision": "20251013", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4606,7 +4606,7 @@ "type": "object" }, "Permission": { -"description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", +"description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", "id": "Permission", "properties": { "allowFileDiscovery": { @@ -4614,11 +4614,11 @@ "type": "boolean" }, "deleted": { -"description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", +"description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.", "type": "boolean" }, "displayName": { -"description": "Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as \"Joe Smith.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"thecompany.com.\" * `anyone` - No `displayName` is present.", +"description": "Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as \"Dana A.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"cymbalgroup.com.\" * `anyone` - No `displayName` is present.", "type": "string" }, "domain": { @@ -4635,11 +4635,11 @@ "type": "string" }, "id": { -"description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.", +"description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, "inheritedPermissionsDisabled": { -"description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", +"description": "When `true`, only organizers, owners, and users with permissions added directly on the item can access it.", "type": "boolean" }, "kind": { @@ -4648,11 +4648,11 @@ "type": "string" }, "pendingOwner": { -"description": "Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.", +"description": "Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.", "type": "boolean" }, "permissionDetails": { -"description": "Output only. Details of whether the permissions on this item are inherited or directly on this item.", +"description": "Output only. Details of whether the permissions on this item are inherited or are directly on this item.", "items": { "properties": { "inherited": { @@ -4664,11 +4664,11 @@ "type": "string" }, "permissionType": { -"description": "Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`", +"description": "Output only. The permission type for this user. Supported values include: * `file` * `member`", "type": "string" }, "role": { -"description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", +"description": "Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "type": "string" } }, @@ -4687,7 +4687,7 @@ "drive.permissions.create" ] }, -"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", +"description": "The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "type": "string" }, "teamDrivePermissionDetails": { @@ -4727,11 +4727,11 @@ "drive.permissions.create" ] }, -"description": "The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.", +"description": "The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.", "type": "string" }, "view": { -"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. ", +"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).", "type": "string" } }, @@ -4751,7 +4751,7 @@ "type": "string" }, "permissions": { -"description": "The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", +"description": "The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Permission" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 4aeb0b475f..a63de9fbd4 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -592,7 +592,7 @@ "testCases": { "methods": { "batchDelete": { -"description": "Delete test cases.", +"description": "Deletes multiple test cases.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases:batchDelete", "httpMethod": "POST", "id": "firebaseappdistribution.projects.apps.testCases.batchDelete", @@ -601,7 +601,7 @@ ], "parameters": { "parent": { -"description": "Required. The parent resource where these test cases will be deleted. Format: `projects/{project_number}/apps/{app_id}`", +"description": "Required. The parent resource of the test cases being deleted. Format: `projects/{project_number}/apps/{app_id}`", "location": "path", "pattern": "^projects/[^/]+/apps/[^/]+$", "required": true, @@ -619,6 +619,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"batchUpdate": { +"description": "Updates multiple test cases.", +"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases:batchUpdate", +"httpMethod": "POST", +"id": "firebaseappdistribution.projects.apps.testCases.batchUpdate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the test cases being updated. Format: `projects/{project_number}/apps/{app_id}`", +"location": "path", +"pattern": "^projects/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/testCases:batchUpdate", +"request": { +"$ref": "GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesRequest" +}, +"response": { +"$ref": "GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Create a new test case.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases", @@ -812,7 +840,7 @@ } } }, -"revision": "20250925", +"revision": "20251015", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1150,7 +1178,7 @@ "type": "object" }, "GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest": { -"description": "The request message for `DeleteTestCase`.", +"description": "The request message for `BatchDeleteTestCase`.", "id": "GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest", "properties": { "names": { @@ -1163,6 +1191,34 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesRequest": { +"description": "The request message for `BatchUpdateTestCase`.", +"id": "GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesRequest", +"properties": { +"requests": { +"description": "Required. The update requests. A maximum number of 1000 test cases can be updated in one batch", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaUpdateTestCaseRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesResponse": { +"description": "The response message for `BatchUpdateTestCase`.", +"id": "GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesResponse", +"properties": { +"testCases": { +"description": "The updated test cases.", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaTestCase" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse": { "description": "The (empty) response message for `CancelReleaseTest`.", "id": "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse", @@ -2130,6 +2186,21 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaUpdateTestCaseRequest": { +"description": "The request message for `UpdateTestCase`.", +"id": "GoogleFirebaseAppdistroV1alphaUpdateTestCaseRequest", +"properties": { +"allowMissing": { +"description": "Optional. If set to true, and the test case is not found, a new test case will be created.", +"type": "boolean" +}, +"testCase": { +"$ref": "GoogleFirebaseAppdistroV1alphaTestCase", +"description": "Required. The test case to update. The test case's `name` field is used to identify the test case to update. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`" +} +}, +"type": "object" +}, "GoogleProtobufEmpty": { "description": "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); }", "id": "GoogleProtobufEmpty", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 22ac30fa1a..9739dfc60f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20251005", +"revision": "20251013", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1729,6 +1729,42 @@ "aspectRatio": { "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", "type": "string" +}, +"imageOutputOptions": { +"$ref": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions", +"description": "Optional. The image output format for generated images." +}, +"personGeneration": { +"description": "Optional. Controls whether the model can generate people.", +"enum": [ +"PERSON_GENERATION_UNSPECIFIED", +"ALLOW_ALL", +"ALLOW_ADULT", +"ALLOW_NONE" +], +"enumDescriptions": [ +"Generation images of people unspecified.", +"Generate images that include adults and children.", +"Generate images of adults, but not children.", +"Block generation of images of people." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions": { +"description": "The image output format for generated images.", +"id": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions", +"properties": { +"compressionQuality": { +"description": "Optional. The compression quality of the output image.", +"format": "int32", +"type": "integer" +}, +"mimeType": { +"description": "Optional. The image format that the output should be saved as.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 29fa5797da..7b2dd439ae 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -468,6 +468,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://firestore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -2406,7 +2416,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index ad5fb0b7fd..56d08c0606 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -468,6 +468,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://firestore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -1402,7 +1412,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json index f6ae55f1e8..99d4389831 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -468,6 +468,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://firestore.us.rep.googleapis.com/", "location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.eu.rep.googleapis.com/", +"location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -867,7 +877,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 9ab2be135f..a98530cda5 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -4160,7 +4160,7 @@ } } }, -"revision": "20251003", +"revision": "20251010", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -6352,6 +6352,18 @@ false "$ref": "GoogleIamAdminV1WorkforcePoolProviderSaml", "description": "A SAML identity provider configuration." }, +"scimUsage": { +"description": "Optional. Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error.", +"enum": [ +"SCIM_USAGE_UNSPECIFIED", +"ENABLED_FOR_GROUPS" +], +"enumDescriptions": [ +"Agentspace only. Do not use SCIM data.", +"Agentspace only. SCIM sync is enabled and SCIM-managed groups are used for authorization checks." +], +"type": "string" +}, "state": { "description": "Output only. The state of the provider.", "enum": [ @@ -6410,7 +6422,7 @@ false "ENCRYPTION" ], "enumDescriptions": [ -"KeyUse unspecified.", +"KeyUse unspecified. Do not use. The purpose of the key must be specified.", "The key is used for encryption." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index 459a222ec4..bcb1536eef 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -682,7 +682,7 @@ } } }, -"revision": "20250524", +"revision": "20251013", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -1254,7 +1254,7 @@ false "type": "object" }, "locations": { -"description": "The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - If unset or empty, the location of authorization is used as the target location. - For global resources: use a single value of \"global\". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., [\"us-east1\", \"us-west1\"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. ", +"description": "The locations of the resource. This field is used to determine whether the request is compliant with Trust Boundaries. Usage: - Must not be empty for services in-scope for Trust Boundaries. Once Trust Boundaries is GA, empty values will cause the request to be rejected if customers enforce Trust Boundaries on the parent CRM nodes. - For global resources: use a single value of \"global\". - For regional/multi-regional resources: use name of the GCP region(s) where the resource exists (e.g., [\"us-east1\", \"us-west1\"]). For multi-regional resources specify the name of each GCP region in the resource's multi-region. NOTE: Only GCP cloud region names are supported - go/cloud-region-names. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/jobs.v3.json b/googleapiclient/discovery_cache/documents/jobs.v3.json index 09f1320a05..37be4e652d 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3.json @@ -652,7 +652,7 @@ } } }, -"revision": "20250326", +"revision": "20251014", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -2313,7 +2313,7 @@ false "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json index ba91851fb2..814c090f97 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json @@ -682,7 +682,7 @@ } } }, -"revision": "20250326", +"revision": "20251014", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -2452,7 +2452,7 @@ false "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v4.json b/googleapiclient/discovery_cache/documents/jobs.v4.json index 04849d6f77..c86716c0eb 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v4.json +++ b/googleapiclient/discovery_cache/documents/jobs.v4.json @@ -903,7 +903,7 @@ } } }, -"revision": "20250326", +"revision": "20251014", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -2500,7 +2500,7 @@ false "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index a530fa0442..7fb5f465c3 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -242,7 +242,7 @@ } } }, -"revision": "20250727", +"revision": "20251012", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -510,7 +510,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", +"PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", +"PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -554,7 +556,9 @@ "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 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. 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." ], @@ -728,7 +732,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", +"PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", +"PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -772,7 +778,9 @@ "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 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. 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." ], diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index f74c0d99ca..c89ffbaf20 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -1425,6 +1425,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2934,7 +2939,7 @@ } } }, -"revision": "20250911", +"revision": "20251009", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3696,6 +3701,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -4191,7 +4203,7 @@ "type": "object" }, "TaskRetryPolicy": { -"description": "Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively.", +"description": "Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively.", "id": "TaskRetryPolicy", "properties": { "maximumBackoff": { @@ -4203,6 +4215,10 @@ "description": "Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.", "format": "google-duration", "type": "string" +}, +"taskRetryDisabled": { +"description": "Optional. If true, task retry is disabled.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 8f9b526c0d..55575e4bf2 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2290,81 +2290,6 @@ } } }, -"remoteTransportProfiles": { -"methods": { -"get": { -"description": "Gets details of a single RemoteTransportProfile.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles/{remoteTransportProfilesId}", -"httpMethod": "GET", -"id": "networkconnectivity.projects.locations.remoteTransportProfiles.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/remoteTransportProfiles/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "RemoteTransportProfile" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists RemoteTransportProfiles in a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles", -"httpMethod": "GET", -"id": "networkconnectivity.projects.locations.remoteTransportProfiles.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filtering results.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Hint for how to order the results.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token identifying a page of results the server should return.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListRemoteTransportProfilesRequest.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/remoteTransportProfiles", -"response": { -"$ref": "ListRemoteTransportProfilesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "serviceClasses": { "methods": { "delete": { @@ -2889,6 +2814,7 @@ "autoSubnetworkConfig.allocRangeSpace": { "description": "Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, \u201c10.0.0.0/8\u201d is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.", "location": "query", +"repeated": true, "type": "string" }, "autoSubnetworkConfig.ipStack": { @@ -3608,195 +3534,13 @@ ] } } -}, -"transports": { -"methods": { -"create": { -"description": "Creates a new Transport in a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports", -"httpMethod": "POST", -"id": "networkconnectivity.projects.locations.transports.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Value for parent.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"transportId": { -"description": "Required. Id of the requesting object", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/transports", -"request": { -"$ref": "Transport" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a single Transport.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", -"httpMethod": "DELETE", -"id": "networkconnectivity.projects.locations.transports.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", -"required": true, -"type": "string" -}, -"requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets details of a single Transport.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", -"httpMethod": "GET", -"id": "networkconnectivity.projects.locations.transports.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Transport" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists Transports in a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports", -"httpMethod": "GET", -"id": "networkconnectivity.projects.locations.transports.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filtering results.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Hint for how to order the results.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token identifying a page of results the server should return.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListTransportsRequest.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/transports", -"response": { -"$ref": "ListTransportsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates the parameters of a single Transport.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}", -"httpMethod": "PATCH", -"id": "networkconnectivity.projects.locations.transports.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$", -"required": true, -"type": "string" -}, -"requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the Transport resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "Transport" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} } } } } } }, -"revision": "20250925", +"revision": "20251009", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3963,6 +3707,26 @@ }, "type": "object" }, +"AutomatedDnsCreationSpec": { +"description": "The specification for automatically creating a DNS record.", +"id": "AutomatedDnsCreationSpec", +"properties": { +"dnsSuffix": { +"description": "Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: \"my-service.example.com.\", \"internal.\"", +"type": "string" +}, +"hostname": { +"description": "Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: \"my-instance\", \"db-1\"", +"type": "string" +}, +"ttl": { +"description": "Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -4136,6 +3900,11 @@ "description": "PSC connection details on consumer side.", "id": "ConsumerPscConnection", "properties": { +"dnsAutomationStatus": { +"$ref": "DnsAutomationStatus", +"description": "Output only. The status of DNS automation for this PSC connection.", +"readOnly": true +}, "error": { "$ref": "GoogleRpcStatus", "deprecated": true, @@ -4343,6 +4112,44 @@ }, "type": "object" }, +"DnsAutomationStatus": { +"description": "The status of DNS automation for a PSC connection.", +"id": "DnsAutomationStatus", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error details if the state is CREATE_FAILED or DELETE_FAILED.", +"readOnly": true +}, +"fqdn": { +"description": "Output only. The fully qualified domain name of the DNS record.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The current state of DNS automation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_CREATE", +"ACTIVE", +"PENDING_DELETE", +"CREATE_FAILED", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"DNS record creation is pending.", +"DNS record is active.", +"DNS record deletion is pending.", +"DNS record creation failed.", +"DNS record deletion failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "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); }", "id": "Empty", @@ -5304,31 +5111,6 @@ }, "type": "object" }, -"ListRemoteTransportProfilesResponse": { -"description": "Message for response to listing RemoteTransportProfiles", -"id": "ListRemoteTransportProfilesResponse", -"properties": { -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -}, -"remoteTransportProfiles": { -"description": "The list of RemoteTransportProfiles.", -"items": { -"$ref": "RemoteTransportProfile" -}, -"type": "array" -}, -"unreachable": { -"description": "Unordered list. Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "ListRouteTablesResponse": { "description": "Response for HubService.ListRouteTables method.", "id": "ListRouteTablesResponse", @@ -5504,31 +5286,6 @@ }, "type": "object" }, -"ListTransportsResponse": { -"description": "Message for response to listing Transports.", -"id": "ListTransportsResponse", -"properties": { -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -}, -"transports": { -"description": "The list of Transport.", -"items": { -"$ref": "Transport" -}, -"type": "array" -}, -"unreachable": { -"description": "Unordered list. Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -5935,6 +5692,10 @@ "description": "The PSC configurations on producer side.", "id": "ProducerPscConfig", "properties": { +"automatedDnsCreationSpec": { +"$ref": "AutomatedDnsCreationSpec", +"description": "Optional. The specification for automatically creating a DNS record for this PSC connection." +}, "serviceAttachmentUri": { "description": "The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.", "type": "string" @@ -6292,138 +6053,6 @@ }, "type": "object" }, -"RemoteTransportProfile": { -"description": "Message describing RemoteTransportProfile object.", -"id": "RemoteTransportProfile", -"properties": { -"createTime": { -"description": "Output only. [Output only] Create time stamp.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Output only. Description of the profile.", -"readOnly": true, -"type": "string" -}, -"flow": { -"description": "Output only. [Output only] Type of provisioning flows supported by this profile.", -"enum": [ -"KEY_PROVISIONING_FLOW_UNSPECIFIED", -"INPUT_ONLY", -"OUTPUT_ONLY", -"INPUT_OR_OUTPUT" -], -"enumDescriptions": [ -"Unspecified key provisioning flow.", -"The activationKey field on the Transport must be included in a create or patch request to establish connectivity.", -"The generatedActivationKey field is populated and must be read from the resource and passed into the other provider.", -"Both activation key fields are allowed for establishing connectivity. If a key is input, the generated key is still present after provisioning is finished." -], -"readOnly": true, -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Output only. Labels as key value pairs.", -"readOnly": true, -"type": "object" -}, -"name": { -"description": "Identifier. Name of the resource in the format of $provider-$site.", -"type": "string" -}, -"orderState": { -"description": "Output only. [Output only] Order state for this profile.", -"enum": [ -"STATE_UNSPECIFIED", -"CLOSED", -"OPEN" -], -"enumDescriptions": [ -"Unspecified state.", -"Not enough capacity for customers to order.", -"Enough capacity to fulfill an order." -], -"readOnly": true, -"type": "string" -}, -"provider": { -"description": "Output only. Name of the provider on the other end of this profile. E.g. \u201cAmazon Web Services\u201d or \u201cMicrosoft Azure\u201d.", -"readOnly": true, -"type": "string" -}, -"providerSite": { -"description": "Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through.", -"readOnly": true, -"type": "string" -}, -"region": { -"description": "Output only. GCP Region where this profile is available.", -"readOnly": true, -"type": "string" -}, -"sla": { -"description": "Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile.", -"enum": [ -"SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED", -"HIGH", -"MAXIMUM" -], -"enumDescriptions": [ -"Unspecified service level availability.", -"This represents a 99.9% service level on the availability of the configured connectivity.", -"This represents a 99.99% service level on the availability of the configured connectivity." -], -"readOnly": true, -"type": "string" -}, -"supportedBandwidths": { -"description": "Output only. List of bandwidth enum values that are supported by this profile.", -"items": { -"enum": [ -"BANDWIDTH_UNSPECIFIED", -"BPS_50M", -"BPS_100M", -"BPS_200M", -"BPS_300M", -"BPS_400M", -"BPS_500M", -"BPS_1G", -"BPS_2G", -"BPS_5G", -"BPS_10G" -], -"enumDescriptions": [ -"Unspecified bandwidth.", -"50 Megabits per second.", -"100 Megabits per second.", -"200 Megabits per second.", -"300 Megabits per second.", -"400 Megabits per second.", -"500 Megabits per second.", -"1 Gigabit per second.", -"2 Gigabits per second.", -"5 Gigabits per second.", -"10 Gigabits per second." -], -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"updateTime": { -"description": "Output only. [Output only] Update time stamp.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "Route": { "description": "A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.", "id": "Route", @@ -7347,141 +6976,6 @@ }, "type": "object" }, -"Transport": { -"description": "Message describing Transport object.", -"id": "Transport", -"properties": { -"adminEnabled": { -"description": "Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.", -"type": "boolean" -}, -"advertisedRoutes": { -"description": "Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.", -"items": { -"type": "string" -}, -"type": "array" -}, -"bandwidth": { -"description": "Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.", -"enum": [ -"BANDWIDTH_UNSPECIFIED", -"BPS_50M", -"BPS_100M", -"BPS_200M", -"BPS_300M", -"BPS_400M", -"BPS_500M", -"BPS_1G", -"BPS_2G", -"BPS_5G", -"BPS_10G" -], -"enumDescriptions": [ -"Unspecified bandwidth.", -"50 Megabits per second.", -"100 Megabits per second.", -"200 Megabits per second.", -"300 Megabits per second.", -"400 Megabits per second.", -"500 Megabits per second.", -"1 Gigabit per second.", -"2 Gigabits per second.", -"5 Gigabits per second.", -"10 Gigabits per second." -], -"type": "string" -}, -"createTime": { -"description": "Output only. [Output only] Create time stamp.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. Description of the Transport.", -"type": "string" -}, -"generatedActivationKey": { -"description": "Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.", -"readOnly": true, -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Labels as key value pairs.", -"type": "object" -}, -"mtuLimit": { -"description": "Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.", -"format": "int32", -"readOnly": true, -"type": "integer" -}, -"name": { -"description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.", -"type": "string" -}, -"network": { -"description": "Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.", -"type": "string" -}, -"providedActivationKey": { -"description": "Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.", -"type": "string" -}, -"region": { -"description": "Required. GCP Region where this Transport is located.", -"type": "string" -}, -"remoteProfile": { -"description": "Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}", -"type": "string" -}, -"stackType": { -"description": "Optional. IP version stack for the established connectivity.", -"enum": [ -"STACK_TYPE_UNSPECIFIED", -"IPV4_ONLY", -"IPV4_IPV6" -], -"enumDescriptions": [ -"Unspecified stack type.", -"Only IPv4 is supported. (default)", -"Both IPv4 and IPv6 are supported." -], -"type": "string" -}, -"state": { -"description": "Output only. [Output only] State of the underlying connectivity.", -"enum": [ -"STATE_UNSPECIFIED", -"CREATING", -"PENDING_CONFIG", -"PENDING_KEY", -"ACTIVE" -], -"enumDescriptions": [ -"Unspecified state.", -"The resource exists locally and is being created / associated with the resource on the remote provider\u2019s end of the underlying connectivity.", -"The Transport exists on both sides of the connection, and is waiting for configuration to finalize and be verified as operational.", -"The Transport was created in GCP. Depending on the profile\u2019s key provisioning flow, this is either waiting for an activation key to be input (the key will be validated that it uses remote resources that match the Transport), or for the generated key to be input to the provider for finalizing. The configured bandwidth is not yet guaranteed.", -"The Transport is configured and the underlying connectivity is considered operational." -], -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. [Output only] Update time stamp.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "VirtualMachine": { "description": "VM instances that this policy-based route applies to.", "id": "VirtualMachine", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 7e10e323cc..ce91da0347 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1233,7 +1233,7 @@ } } }, -"revision": "20250925", +"revision": "20251008", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1898,7 +1898,9 @@ false "CLOUD_NAT_PROTOCOL_UNSUPPORTED", "L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", "L2_INTERCONNECT_UNSUPPORTED_PORT", -"L2_INTERCONNECT_DESTINATION_IP_MISMATCH" +"L2_INTERCONNECT_DESTINATION_IP_MISMATCH", +"NCC_ROUTE_WITHIN_HYBRID_SUBNET_UNSUPPORTED", +"HYBRID_SUBNET_REGION_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1997,7 +1999,9 @@ false "Packet is dropped by Cloud NAT due to using an unsupported protocol.", "Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", "Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", -"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." +"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment.", +"Packet could be dropped because it matches a route associated with an NCC spoke in the hybrid subnet context, but such a configuration is not supported.", +"Packet is dropped because the region of the hybrid subnet is different from the region of the next hop of the route matched within this hybrid subnet." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index e8d6584c38..4a229ce1f9 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20250925", +"revision": "20251008", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1902,7 +1902,9 @@ false "CLOUD_NAT_PROTOCOL_UNSUPPORTED", "L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", "L2_INTERCONNECT_UNSUPPORTED_PORT", -"L2_INTERCONNECT_DESTINATION_IP_MISMATCH" +"L2_INTERCONNECT_DESTINATION_IP_MISMATCH", +"NCC_ROUTE_WITHIN_HYBRID_SUBNET_UNSUPPORTED", +"HYBRID_SUBNET_REGION_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -2001,7 +2003,9 @@ false "Packet is dropped by Cloud NAT due to using an unsupported protocol.", "Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", "Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", -"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." +"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment.", +"Packet could be dropped because it matches a route associated with an NCC spoke in the hybrid subnet context, but such a configuration is not supported.", +"Packet is dropped because the region of the hybrid subnet is different from the region of the next hop of the route matched within this hybrid subnet." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index ae35c83109..2dc5f8c716 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1315,6 +1315,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2014,7 +2019,7 @@ } } }, -"revision": "20250430", +"revision": "20251008", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3048,6 +3053,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 34c2d2a090..9d1334f9b2 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -499,7 +499,7 @@ ], "parameters": { "name": { -"description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", +"description": "Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, @@ -949,6 +949,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -966,7 +971,7 @@ } } }, -"revision": "20250710", +"revision": "20251008", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1268,6 +1273,13 @@ "kmsKey": { "description": "Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.", "type": "string" +}, +"resourcePolicies": { +"description": "Optional. The resource policies to apply to the data disk.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -1637,7 +1649,7 @@ "type": "object" }, "name": { -"description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", +"description": "Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", "readOnly": true, "type": "string" }, @@ -1766,6 +1778,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 229af237ff..a51c9a1fae 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -1153,7 +1153,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", +"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1193,7 +1193,7 @@ ], "parameters": { "pageSize": { -"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", +"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1426,7 +1426,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", +"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1702,6 +1702,48 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"dbNodes": { +"methods": { +"list": { +"description": "Lists the database nodes of a VM Cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}/dbNodes", +"httpMethod": "GET", +"id": "oracledatabase.projects.locations.exadbVmClusters.dbNodes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the node should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dbNodes", +"response": { +"$ref": "ListDbNodesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "exascaleDbStorageVaults": { @@ -2430,7 +2472,7 @@ } } }, -"revision": "20250925", +"revision": "20251009", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 7e970b4227..f486533795 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -378,6 +378,29 @@ "parent" ], "parameters": { +"cycleOptions.initialCycleDuration.count": { +"description": "number of duration units to be included.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"cycleOptions.initialCycleDuration.unit": { +"description": "The unit used for the duration", +"enum": [ +"UNIT_UNSPECIFIED", +"MONTH", +"DAY", +"HOUR" +], +"enumDescriptions": [ +"Default value, reserved as an invalid or an unexpected value.", +"Unit of a calendar month.", +"Unit of a day.", +"Unit of an hour. It is used for testing." +], +"location": "query", +"type": "string" +}, "parent": { "description": "Required. The parent resource name, which is the identifier of the partner. It will have the format of \"partners/{partner_id}\".", "location": "path", @@ -486,6 +509,46 @@ "https://www.googleapis.com/auth/sdm.service" ] } +}, +"resources": { +"lineItems": { +"methods": { +"patch": { +"description": "Updates a line item of a subscription. It should be autenticated with a service account.", +"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}/lineItems/{lineItemsId}", +"httpMethod": "PATCH", +"id": "paymentsresellersubscription.partners.subscriptions.lineItems.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}", +"location": "path", +"pattern": "^partners/[^/]+/subscriptions/[^/]+/lineItems/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to update. Only a limited set of fields can be updated. The allowed fields are the following: - `product_payload.googleHomePayload.googleStructureId`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "SubscriptionLineItem" +}, +"response": { +"$ref": "SubscriptionLineItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/sdm.service" +] +} +} +} } }, "userSessions": { @@ -523,7 +586,7 @@ } } }, -"revision": "20251005", +"revision": "20251012", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -615,6 +678,17 @@ }, "type": "object" }, +"CycleOptions": { +"description": "The cycle options when starting and resuming a subscription.", +"id": "CycleOptions", +"properties": { +"initialCycleDuration": { +"$ref": "Duration", +"description": "Optional. The duration of the initial cycle. Only `DAY` is supported. If set, Google will start the subscription with this initial cycle duration starting at the request time (see available methods below). A prorated charge will be applied. This option is available to the following methods: - partners.subscriptions.provision - partners.subscriptions.resume - partners.userSessions.generate " +} +}, +"type": "object" +}, "Duration": { "description": "Describes the length of a period of a time.", "id": "Duration", @@ -1233,7 +1307,12 @@ "ResumeSubscriptionRequest": { "description": "Request to resume a suspended subscription.", "id": "ResumeSubscriptionRequest", -"properties": {}, +"properties": { +"cycleOptions": { +"$ref": "CycleOptions", +"description": "Optional. The cycle options for the subscription." +} +}, "type": "object" }, "ResumeSubscriptionResponse": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 87446c8c2f..c6a29d902f 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20250928", +"revision": "20251006", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1262,7 +1262,7 @@ true "type": "string" }, "wafTokenAssessment": { -"description": "Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.", +"description": "Optional. Flag for running Web Application Firewall (WAF) token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.", "type": "boolean" } }, @@ -1656,7 +1656,7 @@ true }, "wafSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1WafSettings", -"description": "Optional. Settings for WAF" +"description": "Optional. Settings for Web Application Firewall (WAF)." }, "webSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1WebKeySettings", @@ -2499,7 +2499,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1WafSettings", "properties": { "wafFeature": { -"description": "Required. The WAF feature for which this key is enabled.", +"description": "Required. The Web Application Firewall (WAF) feature for which this key is enabled.", "enum": [ "WAF_FEATURE_UNSPECIFIED", "CHALLENGE_PAGE", @@ -2524,7 +2524,7 @@ true "type": "string" }, "wafService": { -"description": "Required. The WAF service that uses this key.", +"description": "Required. The Web Application Firewall (WAF) service that uses this key.", "enum": [ "WAF_SERVICE_UNSPECIFIED", "CA", diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index bce30082fd..a5811e618f 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -428,6 +428,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -822,6 +827,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -841,7 +851,7 @@ } } }, -"revision": "20240702", +"revision": "20251009", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1968,6 +1978,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 2e8fd942e2..7c95db23b0 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1056,6 +1056,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1073,7 +1078,7 @@ } } }, -"revision": "20251007", +"revision": "20251009", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -2321,7 +2326,8 @@ "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -2426,6 +2432,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2531,7 +2538,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" }, @@ -2970,7 +2978,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -3075,6 +3084,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3180,7 +3190,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" } @@ -4027,6 +4038,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -4967,7 +4985,8 @@ false "type": "string" }, "phase": { -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"deprecated": true, +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", "enum": [ "WINDOW_PHASE_UNSPECIFIED", "WINDOW_PHASE_ANY", @@ -4987,6 +5006,24 @@ false "time": { "$ref": "TimeOfDay", "description": "Optional. Preferred time to start the maintenance operation on the specified day." +}, +"week": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"PHASE_UNSPECIFIED", +"ANY", +"WEEK1", +"WEEK2", +"WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index d0d236a646..705287e108 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1056,6 +1056,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1073,7 +1078,7 @@ } } }, -"revision": "20251007", +"revision": "20251009", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -2321,7 +2326,8 @@ "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -2426,6 +2432,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2531,7 +2538,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" }, @@ -2970,7 +2978,8 @@ false "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", -"SIGNAL_TYPE_DATABOOST_DISABLED" +"SIGNAL_TYPE_DATABOOST_DISABLED", +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" ], "enumDeprecated": [ false, @@ -3075,6 +3084,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3180,7 +3190,8 @@ false "Replication delay.", "Outdated version.", "Outdated client.", -"Databoost is disabled." +"Databoost is disabled.", +"Recommended maintenance policy." ], "type": "string" } @@ -4034,6 +4045,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -4974,7 +4992,8 @@ false "type": "string" }, "phase": { -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"deprecated": true, +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", "enum": [ "WINDOW_PHASE_UNSPECIFIED", "WINDOW_PHASE_ANY", @@ -4994,6 +5013,24 @@ false "time": { "$ref": "TimeOfDay", "description": "Optional. Preferred time to start the maintenance operation on the specified day." +}, +"week": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"PHASE_UNSPECIFIED", +"ANY", +"WEEK1", +"WEEK2", +"WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json index e2ec8a2be9..95fee44bca 100644 --- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json @@ -487,7 +487,7 @@ } } }, -"revision": "20250924", +"revision": "20251015", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { @@ -910,6 +910,31 @@ }, "type": "object" }, +"ObjectRetention": { +"description": "Describes options for object retention update.", +"id": "ObjectRetention", +"properties": { +"retainUntilTime": { +"description": "Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.", +"type": "string" +}, +"retentionMode": { +"description": "Required. The retention mode of the object.", +"enum": [ +"RETENTION_MODE_UNSPECIFIED", +"LOCKED", +"UNLOCKED" +], +"enumDescriptions": [ +"If set and retain_until_time is empty, clears the retention.", +"Sets the retention mode to locked.", +"Sets the retention mode to unlocked." +], +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1032,6 +1057,10 @@ "customTime": { "description": "Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.", "type": "string" +}, +"objectRetention": { +"$ref": "ObjectRetention", +"description": "Optional. Updates objects retention lock configuration. Unset values will be ignored. Set empty values to clear the retention for the object with existing `Unlocked` retention mode. Object with existing `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer to documentation in https://cloud.google.com/storage/docs/object-lock" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 216b03824a..d667b35d95 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -323,7 +323,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -333,6 +333,10 @@ "lowLatencyJourneySynthesis": { "description": "Only for Journey voices. If false, the synthesis is context aware and has a higher latency.", "type": "boolean" +}, +"relaxSafetyFilters": { +"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 260af815f3..565363c62e 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -266,7 +266,7 @@ } } }, -"revision": "20251001", +"revision": "20251014", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -276,6 +276,10 @@ "lowLatencyJourneySynthesis": { "description": "Only for Journey voices. If false, the synthesis is context aware and has a higher latency.", "type": "boolean" +}, +"relaxSafetyFilters": { +"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 9d382c3358..5f58d1e410 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1189,6 +1189,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -1203,7 +1208,7 @@ } } }, -"revision": "20250616", +"revision": "20251015", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -2241,6 +2246,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object"